Skip to main content
POST
/
v1
/
mutations
/
run
Update
curl --request POST \
  --url https://api.sequin.io/v1/mutations/run \
  --header 'Authorization: Bearer <token>'

Documentation Index

Fetch the complete documentation index at: https://sequin.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Update mutation

For update mutations, the request body is an UpdateMutationRequest object with the following shape:
UpdateMutationRequest
{
  kind: "update";
  sync_id: string;
  collection_id: string;
  data: PartialRecord[];
  await_consumer_ids?: string[];
  await_consumers_timeout?: number;
}
We use PATCH in all update mutations.

​
Parameters

​
sync_id
string
required
The ID of the sync that the mutations should apply to.
​
collection_id
string
required
The ID of the collection that the mutations should apply to.
​
records
array
required
A list of one or more PartialRecord objects.
​
await_consumer_ids
array
A list of one or more consumer IDs. See await consumers below.
​
await_consumers_timeout
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
{
  "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:
400 Bad Request
{
  "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:
504 Gateway Timeout
{
  "error": "Error: Salesforce API timed out",
  "docs": [ ... ]
}

​
Examples

Update a single record: 
curl -X POST \
  https://api.sequin.io/v1/mutations/run \
  -H 'content-type: application/json' \
  -H 'authorization: Bearer {token}' \
  -d '{
        "kind": "update",
        "sync_id": "my-sync-id",
        "collection_id": "salesforce:contact",
        "records": [
          {
            "upstream_id": "0031U00000Qn2ZVQAZ",
            "data": {
              "FirstName": "Paul",
              "LastName": "Atreides",
              "Email": "paul@arrakis.org"
            }
          }
        ]
      }'
Update multiple records: 
curl -X POST \
  https://api.sequin.io/v1/mutations/run \
  -H 'content-type: application/json' \
  -H 'authorization: Bearer {token}' \
  -d '{
        "kind": "update",
        "sync_id": "my-sync-id",
        "collection_id": "salesforce:contact",
        "records": [
          {
            "upstream_id": "0031U00000Qn2ZVQAZ",
            "data": {
              "FirstName": "Paul",
              "LastName": "Atreides",
              "Email": "paul@arrakis.org"
            }
          },
          {
            "upstream_id": "0031U00000Qn2ZVQBA",
            "data": {
              "FirstName": "Duncan",
              "LastName": "Idaho",
              "Email": "duncan@arrakis.org"
            }
          }
        ]
      }'