Delete
Delete mutation
For delete mutations, the request body is a DeleteMutationRequest object with the following shape:
{
kind: "delete";
sync_id: string;
collection_id: string;
upstream_ids: string[];
await_consumer_ids?: string[];
await_consumers_timeout?: number;
}
Parameters
The ID of the sync that the mutations should apply to.
The ID of the collection that the mutations should apply to.
A list of one or more upstream IDs.
A list of one or more consumer IDs. See await consumers below.
The number of milliseconds to wait for consumers to finish processing a mutation. Defaults to 30000 (30 seconds). See await consumers below.
Response
If the mutation succeeds, Sequin will return a JSON object with a records property containing each record:
{
"records": [
{
"sync_id": "70a313f8-7c94-43d4-8d0c-5659a52de5c4",
"collection_id" : "salesforce:task",
"upstream_id": "0018b000021BldZAAS",
"upstream_updated_at": "2024-11-10T18:39:00.070453Z",
"data": {
"activity_date": "2023-09-12",
"description" : "task description [ ... ] ",
// ...
},
"deleted": false,
// ...
}
]
}
If the mutation fails due to a validation error, Sequin will return a 400 Bad Request response with an error message:
{
"error": "Error: Salesforce validation error: `Invalid email`",
"docs": [ ... ]
}
If the mutation fails due to the upstream API timing out, Sequin will return a 504 Gateway Timeout response with an error message:
{
"error": "Error: Salesforce API timed out",
"docs": [ ... ]
}
Examples
Delete a single record:
curl -X POST \
https://api.sequin.io/v1/mutations/run \
-H 'content-type: application/json' \
-H 'authorization: Bearer {token}' \
-d '{
"kind": "delete",
"sync_id": "my-sync-id",
"collection_id": "salesforce:contact",
"upstream_ids": [
"0031U00000Qn2ZVQAZ"
]
}'
Delete multiple records:
curl -X POST \
https://api.sequin.io/v1/mutations/run \
-H 'content-type: application/json' \
-H 'authorization: Bearer {token}' \
-d '{
"kind": "delete",
"sync_id": "my-sync-id",
"collection_id": "salesforce:contact",
"upstream_ids": [
"0031U00000Qn2ZVQAZ",
"0031U00000Qn2ZVQBA"
]
}'