API referenceContacts

Merge a contact into this one

POST
/v2/contacts/{id}/merge

Folds sourceId into the path contact (identities, conversations, deals, notes, tags…). Undoable from the console for 7 days.

Authorization

ApiKey
headerAuthorizationBearer <token>

An API key from Developers → API keys: Authorization: Bearer gauge_live_… (or pulse_k_live_…).

Path Parameters

id*string

The surviving contact id.

Formatuuid

Header Parameters

Gauge-Version?string

A dated version. Default 2026-10-21.

Idempotency-Key*string

Required on every POST. Retries with the same key replay the first response for 24 h.

Length1 <= length <= 255

Request Body

application/json
  1. body
sourceId*string
Formatuuid
fieldChoices?

Response Body

The merge and the surviving contact.

application/json
  1. response
mergeId*string
Formatuuid
survivorId*string
Formatuuid
sourceId*string
Formatuuid
undoableUntil*string
contact*
Example Request
curl -X POST 'https://app.gauge.chat/api/v2/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/merge' \  -H 'Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{  "sourceId": "797f5a94-3689-4ac8-82fd-d749511ea2b2"}'
Example Response
{  "mergeId": "68ee5d1c-a214-427b-a86f-8590cb2304a9",  "survivorId": "04332687-e080-4357-beb8-d25b9bdf9dc4",  "sourceId": "797f5a94-3689-4ac8-82fd-d749511ea2b2",  "undoableUntil": "string",  "contact": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "displayName": "string",    "email": "string",    "phone": "string",    "title": "string",    "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",    "companyName": "string",    "lifecycleStage": "string",    "isVip": true,    "tags": [      "string"    ],    "customFields": {      "property1": null,      "property2": null    },    "identities": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "channel": "string",        "externalId": "string",        "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d"      }    ],    "createdAt": "string",    "updatedAt": "string"  }}