Skip to main content
POST
Add Do-Not-Call Number

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
phone
string
required

The number, with its country code. Spaces, dashes and brackets are ignored; a number without one is read as Indian.

Example:

"+91 98765 43210"

reason
string | null

Why, in your own words — kept for whoever later wonders whether to remove it. 200 characters at most.

Example:

"Complaint by email, 6 Oct"

Response

Already on the list; the existing entry.

A number no outbound call may ring.

object
enum<string>
required
Available options:
do_not_call
phone
string
required

E.164, with the plus.

Example:

"+919876543210"

source
enum<string>
required

How it got here: added in the console, by this API, or by the agent when the caller asked during a call.

Available options:
console,
api,
call
Example:

"call"

callId
string | null
required

The call it was asked on, as Get Call takes it, when source is call.

Example:

"out_9f2c1a44-6b0e-4c1d-8a7f-2e5b3c9d1f60"

reason
string | null
required
Example:

"Asked on a call not to be called again."

createdAt
string<date-time>
required
Example:

"2026-10-07T09:12:44.018Z"