Skip to main content
PATCH
Update Workspace

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. Refused with 404 (Workspace not found.) when the id is unknown, is not one of your customers, or is not an org_… id; 410 when that customer was deleted (restore it with POST /customers/{id}/restore until it is erased); 403 when the key belongs to one customer workspace (it cannot act as another); 400 when your workspace is not a developer workspace. /customers/* and GET /customers/usage are your own workspace's and refuse the header with 400: call them without it.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Body

application/json

Send name, timezone, callRetentionDays, or any of them.

name
string

The new name: 2 to 80 characters (longer is refused), no web or email address, no markup or hidden characters.

Required string length: 2 - 80
Example:

"Sunrise Dental Clinic Pvt Ltd"

timezone
string

An IANA time zone, such as Asia/Kolkata or Europe/London.

Example:

"Asia/Kolkata"

callRetentionDays
integer | null

Keep calls' recordings and transcripts for this many days, from 1 to your plan's planRetentionDays (a longer number is refused with a 400 naming your plan's maximum). From the next night, older calls lose their recording and transcript; their billing record stays. null goes back to your plan's window for recordings and keeps transcripts.

Required range: x >= 1
Example:

14

Response

The workspace as it now is.

id
string
required

The workspace's id (org_…).

Example:

"org_c2a84f17-6e3b-4d9a-b051-8f7e2d4c1a69"

name
string
required

Its name, as the console and invitation emails show it.

Maximum string length: 80
Example:

"Sunrise Dental Clinic"

slug
string
required

Its address in the console. Never changes.

Example:

"sunrise-dental"

timezone
string
required

Its IANA time zone; every date in the console is shown in it.

Example:

"Asia/Kolkata"

callRetentionDays
integer | null
required

How many days calls' recordings and transcripts are kept. Every night, the content of calls older than this is deleted the way Delete Call Content deletes it — the billing record stays. Null keeps recordings for your plan's planRetentionDays and transcripts with no end.

Example:

14

planRetentionDays
integer
required

The longest your plan keeps recordings, and so the most callRetentionDays may be: 30 on pay-as-you-go, 49 on Pro, 75 on Scale, 365 on Enterprise.

Example:

30

createdAt
string<date-time>
required
Example:

"2026-08-14T05:22:31.904Z"