Create a resource
Creates a resource of the given object type. The type in the body must match the object path parameter. Returns the created resource as a JSON:API document.
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_*).
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 POST "https://example.com/workspaces/string/objects/string/resources" \ -H "Content-Type: application/json" \ -d '{ "data": { "type": "person", "attributes": { "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" } } }'{ "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" } }, "included": [], "meta": {}}Update records in bulk
Applies partial updates to multiple records in one request. Each entry names the record by `id` and lists only the fields to change.
List deleted resources
Returns a paginated JSON:API collection of the object’s recently deleted records, newest deletion first. Each resource’s `attributes` are the record’s field values as they stood at the moment of deletion, plus `_deleted_at`. Deletions older than 30 days are not returned. A record the caller could not read while it existed is not returned either. Poll incrementally with `filter[_deleted_at][Greater than]=1787273241` (epoch seconds) to read only what was deleted since your last call; `Less than` walks backwards into older deletions instead. Unlike `/resources`, this endpoint accepts neither `include` — `included` is always empty — nor `sortOrder`.