Skip to main content
PATCH
Update Contact

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Path Parameters

id
string
required

The contact's id (cust_…).

Body

application/json

Any subset of the create fields; at least one. Fields left out keep their values.

phone
string

A new number for them. Normalised as on create.

name
string | null

Their name, or null to clear it.

Maximum string length: 120
email
string<email> | null

Their email, or null to clear it.

Maximum string length: 200
externalId
string | null

Your CRM's id, or null to clear it.

Maximum string length: 200
tags
string[]

Replaces the whole list. Normalised as on create.

Maximum array length: 20
language
enum<string> | null

The language to write to them in, auto, or null.

Available options:
auto,
English,
Hindi,
Assamese,
Bengali,
Bodo,
Dogri,
French,
German,
Gujarati,
Indonesian,
Italian,
Japanese,
Kannada,
Kashmiri,
Konkani,
Korean,
Maithili,
Malayalam,
Manipuri,
Marathi,
Nepali,
Odia,
Polish,
Portuguese,
Punjabi,
Russian,
Sanskrit,
Santali,
Sindhi,
Spanish,
Swahili,
Tamil,
Telugu,
Thai,
Turkish,
Urdu,
Vietnamese,
null
note
string | null

Free-text notes, or null to clear them.

Maximum string length: 2000

Their word on marketing messages, recorded with the time and where it came from — what a regulator asks.

Response

The contact as saved.

id
string
required

The contact's id (cust_…).

Example:

"cust_4e7b1c9d-2a6f-4385-b0d2-9f6a3e8c1b74"

phone
string | null
required

Digits only, with the country code — 919876543210.

name
string | null
required

Their name.

email
string | null
required

Their email, lower-cased.

externalId
string | null
required

Your CRM's id for them, unique in your workspace.

tags
string[]
required

Their tags, lower-case and hyphenated.

language
string | null
required

The language to write to them in, e.g. Hindi, or auto to match theirs.

note
string | null
required

Free-text notes.

source
string
required

How you came to have them: agent (they spoke to an agent), import, api, whatsapp_app.

acquiredFrom
string | null
required

Where the lead came from, when recorded.

createdAt
string<date-time>
required

When the contact was created.