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.

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.

entity*string

The object type: a built-in entity (person, company, deal, …) or a custom object (c_*).

fieldName*string

The name of the relationship field to delete.

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/schemas/string/relationships/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"
    }
  }
}