SugarCRM SupportProduct GuidesSugar DeveloperSugar Developer Guide 10.2IntegrationWeb ServicesREST APIEndpoints/Integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PUT
This release is only available for SugarCloud customers.

/Integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PUT

Overview

Sets a sync key value for a record. Note that the PATCH method is recommended over the PUT method.

Request Arguments

Name Type Description Required
module String The module the record belongs to True
record_id String The ID of the record whose sync key will be set True
sync_key_field_name String The name of the field that contains sync_key_field_value (the default field is named sync_key but can be renamed via code customization) True
sync_key_field_value String A unique ID for the record identifying it in an external system True

Request

/integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value

Response Arguments

Name Type Description
record String The ID of the record whose sync key was set.

Response

{
record: "a0328573-a252-a27c-3530-4e4297d4c9e1"
}

Change Log

Version Change
v11_10 Added /integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PUT endpoint.

Last modified: 2020-10-01 14:16:02