Update records in bulk

Applies partial updates to multiple records in one request. Each entry names the record by `id` and lists only the fields to change.

Authorization

apiKey

Authorization<token>

API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.

In: header

Path Parameters

workspace*string

The workspace slug — the {slug} segment of your Clarify workspace URL.

object*string

The object type: a built-in entity (person, company, deal, …) or a custom object (c_*).

Query Parameters

silent?boolean

When true, suppresses in-app and Slack notifications for this mutation.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

data*array<>

The per-resource changes to apply.

meta?

Per-field write strategies, keyed by field name; controls how array, collection, and object values are merged instead of replaced.

Response Body

`application/json`

curl -X PATCH "https://example.com/workspaces/string/objects/string/records" \  -H "Content-Type: application/json" \  -d '{    "data": [      {        "type": "person",        "id": "5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71",        "attributes": {          "job_title": "CMO"        }      }    ]  }'

{
  "links": {
    "next": null,
    "prev": null
  },
  "meta": {
    "total_records": 1,
    "total_pages": 1,
    "offset": 0,
    "limit": 500
  },
  "data": [
    {
      "type": "person",
      "id": "5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71",
      "attributes": {
        "_id": "5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71",
        "name": {
          "first_name": "Jane",
          "last_name": "Doe"
        },
        "email_addresses": {
          "items": [
            "jane@acme.com"
          ]
        },
        "job_title": "VP of Marketing",
        "company_id": "c0a80121-7ac0-4b1c-8b6d-3e5f9a2d4c88",
        "_created_at": "2026-01-15T09:30:00.000Z",
        "_updated_at": "2026-02-01T17:45:00.000Z"
      }
    }
  ]
}