API referenceContacts

Add an identity

POST
/v2/contacts/{id}/identities

Phones are normalized to E.164 (send country for a national number). A handle another contact holds is a 409.

Authorization

ApiKey
headerAuthorizationBearer <token>

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

Path Parameters

id*string

The 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
channel*string
Value in"whatsapp_cloud""whatsapp_web""instagram""messenger""email""discord""x""webchat""voice""sms"
externalId*string
Length1 <= length <= 320
country?string
Value in"US""CA""GB"

Response Body

The identity.

application/json
  1. response
id*string
Formatuuid
channel*string
externalId*string
connectionId*|
Formatuuid
Example Request
curl -X POST 'https://app.gauge.chat/backend/v2/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/identities' \  -H 'Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{  "channel": "whatsapp_cloud",  "externalId": "string"}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "channel": "string",  "externalId": "string",  "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d"}