Clarify API
Records

Delete records in bulk

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

DELETE
/workspaces/{workspace}/objects/{object}/records
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.

Response Body

application/json

curl -X DELETE "https://example.com/workspaces/string/objects/string/records" \  -H "Content-Type: application/json" \  -d '{    "items": [      "5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71"    ]  }'
{}