Skip to main content
POST
sms.template.send

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

The ref returned by sms.template.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
to
string
required

Recipient phone number; personal data sent for delivery.

Pattern: ^\+[1-9]\d{1,14}$
variables
object

Case-sensitive template variables, at most 50 bounded strings.

Whether to shorten links; defaults off.

Lifetime of shortened links in seconds.

Required range: 1 <= x <= 31536000

Response

The result

status
string
required

Accepted for delivery; not a delivery receipt.

Allowed value: "queued"
ref
string

Reference to what this call created. Pass it as ref to sms.status.