Skip to main content
POST
sms.template.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
name
string
required

Your display name for this template.

Required string length: 1 - 100
body
string
required

Template text, at most 1600 UTF-16 code units; variables use their case-sensitive names.

Required string length: 1 - 1600
senderLabel
string
required

Your registered sender label, not a phone number.

Required string length: 1 - 32
Pattern: ^[A-Za-z0-9]{1,32}$
dltTemplateId
string

Your own registered delivery template identifier.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9_-]+$
encoding
enum<string>
default:normal

Normal alphabet or Unicode encoding.

Available options:
normal,
unicode

Response

The result

name
string
required

Your template display name.

ref
string

Reference to what this call created. Pass it as ref to sms.template.send or sms.template-version.create or sms.template-versions.list.