/integrate//:sync_key_field_name/:sync_key_field_value DELETE
Overview
Deletes the record with the given sync_key_field_name.
Request Arguments
| Name |
Type |
Description |
Required |
|---|
| module |
String |
The module the record belongs to |
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>/:sync_key_field_name/:sync_key_field_value
Response Arguments
| Name |
Type |
Description |
|---|
| record |
String |
The ID of the record that was deleted. |
Response
Status 200
{
"id": "a0328573-a252-a27c-3530-4e4297d4c9e1"
}
Change Log
| Version |
Change |
|---|
| v11_10 |
Added /integrate/<module>/:sync_key_field_name/:sync_key_field_value DELETE endpoint. |