Can't set a sync key value for a record using the API

Hi Kian Tray

Does it work fine if you use the default "sync_key" field provided, instead of using the name field?

The sync_key fields are "special", and they need some specific know-how to add a new sync_key field type. You would not be able to use the "name" pre-existing field as a sync_key field.

Here is the template of what a sync_key field type should look like (and its database index) to help you get started

$vardefs = [
    'fields' => [
        'sync_key' => [
            'is_sync_key' => true,
            'name' => 'sync_key',
            'vname' => 'LBL_SYNC_KEY',
            'type' => 'varchar',
            'enforced' => '',
            'required' => false,
            'massupdate' => false,
            'readonly' => true,
            'default' => null,
            'isnull' => true,
            'no_default' => false,
            'comments' => 'External default id of the remote integration record',
            'help' => '',
            'importable' => 'true',
            'duplicate_merge' => 'disabled',
            'merge_filter' => 'disabled',
            'duplicate_on_record_copy' => 'no',
            'audited' => true,
            'reportable' => true,
            'unified_search' => false,
            'calculated' => false,
            'len' => '100',
            'size' => '20',
            'studio' => [
                'recordview' => true,
                'wirelessdetailview' => true,
                'listview' => false,
                'wirelesseditview' => false,
                'wirelesslistview' => false,
                'wireless_basic_search' => false,
                'wireless_advanced_search' => false,
                'portallistview' => false,
                'portalrecordview' => false,
                'portaleditview' => false,
            ],
        ],
    ],
    'indices' => [
        'sync_key' => [
            'name' => 'idx_' . strtolower($table_name) . '_skey',
            'type' => 'unique',
            'fields' => ['sync_key'],
        ],
    ],
];

In addition to that, here https://github.com/esimonetti/sugar-new-sync-key-field you can find a sample Sugar installable package on how to add new sync_key type fields.

Hope it helps!

Hi Enrico,

Thanks for you reply. I tested the operation using the keyword "sync_key", however I still get the same error message: "Could not find a route with 5 elements"

What Sugar version do you have? 10.2? (About page, after clicking on your profile picture on the top right of the screen)

What Sugar version do you have? 10.2? (About page, after clicking on your profile picture on the top right of the screen)

Hi Enrico, it's version 10.1.0 (Version 10.1.0 (Build 201 E) (Q3 2020))

That's the issue then. The api is only available since version 10.2

Hi Kian,

In addition to Enrico's reply, the  Upsert EndPoint  and sync key is the new field introduced in all modules from Q4 2020 release(10.2 SugarCRM version).

Thank you for looking into this