Skip to main content
PATCH
Update Customer

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.

Path Parameters

id
string
required

The customer's id (org_…), as Create Customer answered.

Body

application/json

Send at least one field. Any other field is refused.

name
string

The customer's name.

Required string length: 1 - 120
Example:

"Sunrise Dental Clinic Pvt Ltd"

externalId
string | null

Your own id for this customer; null clears it.

Maximum string length: 128
Pattern: ^[A-Za-z0-9._:-]{1,128}$
Example:

"clinic-0042"

metadata
object

Merged into what the customer has: keys you leave out are kept, a key set to null is removed. Values are strings (up to 500 characters), numbers or booleans; at most 50 keys and 8 KB once merged.

Example:
timezone
string

An IANA time zone. It cannot be cleared, only changed.

Example:

"Asia/Kolkata"

allottedCallLines
integer | null

How many of your call lines this customer may use at once; null for no cap.

Required range: x >= 0
Example:

3

Response

The customer as it now is.

A workspace you created for one of your customers.

id
string
required

The customer's id (org_…). Send it as Thinnest-Workspace to act inside this customer.

Example:

"org_5b2f9c1e-8a4d-4f7b-9e3a-2c6d1f0a7b84"

name
string
required

The customer's name.

Maximum string length: 120
Example:

"Sunrise Dental Clinic"

externalId
string | null
required

Your own id for this customer, unique among your customers; null when you gave none.

Example:

"clinic-0042"

metadata
object
required

Your own flat key-value data about the customer: up to 50 keys of 1-40 characters, each value a string (up to 500 characters), a number or a boolean. No nested objects or lists; 8 KB in all.

Example:
timezone
string
required

The customer's IANA time zone; every date its console shows is in it.

Example:

"Asia/Kolkata"

allottedCallLines
integer | null
required

How many of your call lines this customer may use at once; null for no cap.

Required range: x >= 0
Example:

2

archivedAt
string<date-time> | null
required

When the customer was deleted; null while it is live.

Example:

null

eraseAfter
string<date-time> | null
required

When a deleted customer will be erased for good (30 days after deletion); null while it is live.

Example:

null

createdAt
string<date-time>
required

When the customer was created.

Example:

"2026-10-02T06:14:22.418Z"