Update a record

Applies a partial update to a record: only the fields present in `attributes` are changed, all other fields keep their current values.

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_*).

id*string

The unique ID of the record.

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*

The 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/string" \  -H "Content-Type: application/json" \  -d '{    "data": {      "type": "person",      "id": "5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71",      "attributes": {        "job_title": "CMO"      }    }  }'

{
  "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"
    }
  }
}