Clarify API
Records

Merge records

Merges the source records listed in `sources` into the target record. Field values and relationships are combined onto the target, and the source records are deleted. This cannot be undone.

POST
/workspaces/{workspace}/objects/{object}/records/{record}/merges
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_*).

record*string

The unique ID of the record.

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

curl -X POST "https://example.com/workspaces/string/objects/string/records/string/merges" \  -H "Content-Type: application/json" \  -d '{    "data": {      "type": "company",      "attributes": {        "sources": [          "c0a80121-7ac0-4b1c-8b6d-3e5f9a2d4c88"        ]      }    }  }'
Empty