Skip to main content
POST
Add SMS Template

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
name
string
required
body
string
required
dltTemplateId
string
required
category
enum<string>
required
Available options:
transactional,
service_implicit,
service_explicit
providerTemplateId
string | null
agentMaySend
boolean

Let an agent send it during a call or chat. Default false.

Response

Added.

id
string<uuid>
required
name
string
required

Your name for it; the agent sees it.

body
string
required

As approved on DLT, with {#var#} blanks.

dltTemplateId
string
required
providerTemplateId
string | null
required

MSG91's template id or Fast2SMS's message id; null with other providers.

category
enum<string>
required
Available options:
transactional,
service_implicit,
service_explicit
agentMaySend
boolean
required

Whether an agent may send this template during a call or chat (its send_sms tool). The after-call message is chosen per agent and is not affected.