Skip to main content
POST
Create 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.

Headers

Idempotency-Key
string

Any unique string. A retry with the same key within 24 hours returns the first request's answer instead of acting twice.

Maximum string length: 255

Body

application/json
name
string
required

The customer's name, as your dashboard shows it. Trimmed.

Required string length: 1 - 120
Example:

"Sunrise Dental Clinic"

externalId
string | null

Your own id for this customer: 1-128 letters, digits, ., _, : or -. Unique among your customers, and filterable on List Customers.

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

"clinic-0042"

metadata
object

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 | null

An IANA time zone such as Asia/Kolkata or Europe/London. Leave it out for the default.

Example:

"Asia/Kolkata"

idempotencyKey
string

The same as the Idempotency-Key header, for clients that cannot set headers. The header wins when both are sent.

Maximum string length: 255

Response

The customer was created.

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"