Replace related records
Replaces the linked records for to-one and many-to-many relationships with the records in data: links not listed are removed. For one-to-many relationships the listed records are linked additively; pass id: null to unlink every related record first.
API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.
In: header
Path Parameters
The workspace slug — the {slug} segment of your Clarify workspace URL.
The object type: a built-in entity (person, company, deal, …) or a custom object (c_*).
The unique ID of the record.
The relationship field name as defined in the object’s schema, e.g. people or companies.
Query Parameters
When true, suppresses in-app and Slack notifications for this mutation and batches its live updates, so open views can lag by up to 20 seconds.
Header Parameters
The API version for this request. Send 2026-11 to get the behavior documented here. Omit it to use your API key's version, which this header can raise but not lower.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PATCH "https://example.com/workspaces/string/objects/string/records/string/relationships/string" \ -H "clarify-version: 2026-11" \ -H "Content-Type: application/json" \ -d '{ "data": [ { "type": "deal", "id": "e7c9a1f4-2b8d-4c6e-9f0a-5d3b7e1c8a42" } ] }'{}List related records
Returns one page of the records linked to a record through the given relationship, e.g. the deals related to a person. Page with `page[offset]` and `page[limit]`; the response carries `links` and `meta.total_records`.
Autofill record fields
Fills fields on records by running each field's autofill: enrichment, AI or a formula. Pick records by `record_ids` and fields by `fields` (all autofill fields when left out). Fills run in the background and write to the records. Set `max_credits` to cap what AI fields may spend.