Replace related records

Replaces the full set of records linked through the given relationship with the records in `data`. Links not listed are removed; this is not additive.

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.

relationship*string

The relationship field name as defined in the object’s schema, e.g. people or companies.

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.

data*array<>

The related records to link.

Response Body

`application/json`

curl -X PATCH "https://example.com/workspaces/string/objects/string/records/string/relationships/string" \  -H "Content-Type: application/json" \  -d '{    "data": [      {        "type": "deal",        "id": "e7c9a1f4-2b8d-4c6e-9f0a-5d3b7e1c8a42"      }    ]  }'

{}