Clarify API
Records

Delete a record

Permanently deletes a record. This cannot be undone.

DELETE
/workspaces/{workspace}/objects/{object}/records/{id}

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.

Response Body

application/json

curl -X DELETE "https://example.com/workspaces/string/objects/string/records/string"
{}

Create a record

Creates a record of the given object type. Pass `match_on` with the name of a unique field to upsert: when an incoming value matches exactly one existing record, that record is updated instead of a new one being created.

Delete records in bulk

Permanently deletes the records listed in `items`. This cannot be undone.