Skip to main content
POST
Send Test SMS

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

An Indian mobile number.

Example:

"+919876543210"

templateId
string<uuid>
required
values
string[]
required

One per {#var#}, in order.

Maximum string length: 30

Response

The provider accepted it.

sent
enum<boolean>
required
Available options:
true
messageRef
string | null
required

The provider's id for the message.

text
string
required

The SMS as sent.