Unlink related records
Removes the links to the records in data from the given relationship. The records themselves are not deleted.
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.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X DELETE "https://example.com/workspaces/string/objects/string/records/string/relationships/string" \ -H "Content-Type: application/json" \ -d '{ "data": [ { "type": "deal", "id": "e7c9a1f4-2b8d-4c6e-9f0a-5d3b7e1c8a42" } ] }'{}List record attachments
Returns the attachments on a record, both user uploads and files extracted from emails. Omit `page` to return all attachments.
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`.