Skip to main content
POST
Delete

Delete mutation

For delete mutations, the request body is a DeleteMutationRequest object with the following shape:
DeleteMutationRequest

Parameters

string
required
The ID of the sync that the mutations should apply to.
string
required
The ID of the collection that the mutations should apply to.
array
required
A list of one or more upstream IDs.
array
A list of one or more consumer IDs. See await consumers below.
integer
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:
200 OK
If the mutation fails due to a validation error, Sequin will return a 400 Bad Request response with an error message:
400 Bad Request
If the mutation fails due to the upstream API timing out, Sequin will return a 504 Gateway Timeout response with an error message:
504 Gateway Timeout

Examples

Delete a single record:
Delete multiple records: