Delete a custom object
Deletes a custom object type and all of its records. The deletion runs asynchronously: the response returns a task you can poll to track progress. Only custom (c_*) objects can be deleted. This cannot be undone.
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 custom object type to delete (a c_* identifier).
Query Parameters
When true, suppresses in-app and Slack notifications for this mutation.
Response Body
application/json
curl -X DELETE "https://example.com/workspaces/string/schemas/objects/string"{ "data": { "type": "async-task", "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "attributes": { "_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "user_id": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81", "type": "schema_modification", "progress": 0, "total": null, "metadata": { "entity": "c_project" }, "queued_at": "2026-01-15T09:30:00.000Z", "started_at": null, "completed_at": null, "failed_at": null, "error_code": null, "_created_at": "2026-01-15T09:30:00.000Z", "_updated_at": "2026-01-15T09:30:00.000Z" } }}Add object relationships
Creates relationship fields between object types. The `attributes` map is keyed first by object type, then by field name, and both sides of each relationship must be supplied together so the pairing is consistent. On `one-to-many` and `many-to-many` sides, the field must declare `"oneOf": [{ "$ref": "https://getclarify.ai/schemas/core/collectionOfIds" }, { "type": "null" }]` — the exact `$ref` string is required. The change is applied asynchronously and the response body is empty.
Delete an object relationship
Deletes a relationship field from an object type, along with its counterpart field on the related object. The deletion runs asynchronously: the response returns a task you can poll to track progress. Deleting an already-removed relationship is a no-op that still returns a task.