/integrate//: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.

Important: This endpoint is restricted to Admin users only. Non-admin users will receive an authorization error.

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

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

{
"success": true
}

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