Skip to main content
PUT
Save Carrier Account

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.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Path Parameters

provider
enum<string>
required

Which carrier the account is with. A carrier a brought number can be on — whose network your own account is with.

Available options:
plivo,
vobiz,
twilio,
telnyx
Example:

"twilio"

Body

application/json
token
string
required

The account's secret: its auth token, or for telnyx its API key.

Example:

"9b7c2e4f1a8d3065c7e2b9f14d6a8e3c"

accountId
string

Your account's id (its Auth ID or Account SID). Required for every carrier but telnyx, which ignores it.

Example:

"AC3f9e2b7d41c08a6e5b1d2f7c9e04a41c"

Response

The keys were checked and saved.

provider
enum<string>
required

A carrier a brought number can be on — whose network your own account is with.

Available options:
plivo,
vobiz,
twilio,
telnyx
Example:

"twilio"

accountEnding
string | null
required

The last four characters of the account id, so you can tell which account is connected; empty for an id too short to hint at.

Example:

"a41c"