Your first customer makes your workspace a developer workspace. A workspace that resells our
console under its own brand (white label) cannot also have API customers.
Create a customer
201 Created
Send an
Idempotency-Key so a retried request returns the same customer instead of making a
second one. Creating a customer needs a key with full access.
Work inside a customer
AddThinnest-Workspace with the customer’s id to any request. It runs inside that customer
as if the customer had sent it. X-Workspace is the same header under a neutral name; send one or
the other. Both naming different workspaces is refused with 400.
Your key’s access level applies inside the customer too: a read-only key can only read there.
List customers
nextCursor back as cursor for the next page. Filters: externalId,
archived=true (deleted, waiting to be erased), createdAfter, createdBefore (ISO 8601 times).
Manage customers from your own workspace — without Thinnest-Workspace.
Get one customer
spendThisMonthMicro is what this customer’s usage has cost you since the 1st of the month (UTC),
in millionths of your currency — 1840000 is ₹1.84.
Update a customer
name, externalId (null clears it), timezone, allottedCallLines (how many of
your call lines this customer may use at once; null for no cap) and metadata. Metadata is
merged: keys you leave out are kept, and a key set to null is removed.
Delete a customer
- requests into it answer
410, and keys made for it stop working; - its webhooks are switched off, its campaigns cancelled, its sequences and scheduled callbacks stopped;
- a call already in progress finishes;
- 30 days later it is erased: every conversation, contact, recording and file.
Keys for one customer
To give a customer its own API access, or to run one customer’s integration on a key that cannot reach the others:ta_live_…) is in the response once. scope is full, build or read.
A key made for one customer works only in that customer.
Move a phone number between customers
A number one customer rents can be handed to another customer, or to your own workspace, with its digits kept — for a customer that is splitting in two, or a number you rented for yourself while setting a customer up. In the console it is on the Phone Numbers page: open the number’s menu and choose Move to another workspace…. Through the API:from, to and paidThrough — the last month already paid, after which the new
workspace’s rent begins. The number arrives unassigned; point it with
PATCH /api/v1/phone-numbers/{number} as the new workspace. An Indian number needs the new
workspace’s own business details approved first (number_move_needs_business_details), and nothing
moves during a live call (number_on_live_call). See
Move Phone Number for every refusal.
Billing
Everything your customers use — calls, messages, replies, phone number rental — is charged to your balance at your plan’s prices. Your customers have no balance of their own. When your balance runs out, your customers stop with you until you top up. A customer is always on your plan. Your plan decides how many customers you can have:
Need more? Write to us. A deleted customer counts until it is erased.
On the Free plan, the included replies, voice minutes and WhatsApp messages are shared by you and
all your customers — one trial, not one each.
What a customer can see
Your balance stays yours. Inside a customer,GET /api/v1/usage returns "billedTo": "developer" and
no wallet, and its console shows no balance and nothing to pay — so a key you give a customer, or a
person you invite into it, never sees what you hold.
Your cloned voices
Every voice you clone can be used by all your customers’ agents, automatically: inside a customer,GET /voices lists it with "sharedFromDeveloper": true. Only you
can rename or delete it, and it counts against your clone limit. Its id inside a customer is your
own voice’s id, the same one you see in your workspace, so you set it as an agent’s voice the
same way. A customer’s own clones are its own; you do not see them. More on the Voice Clone page.
How long a customer’s calls are kept
SetcallRetentionDays on a customer with
PATCH /workspace and the Thinnest-Workspace header,
the same as any other setting of theirs. See How long calls are kept.