Skip to main content
POST
Send an SMS

Authorizations

Authorization
string
header
required

An API key from the dashboard. sk_live_… sends; sk_test_… validates and returns ids without sending.

Headers

Idempotency-Key
string

Up to 255 characters. The same key and body return the same response for 24 hours.

Maximum string length: 255

Body

application/json
to
string
required

E.164.

Example:

"+27821234567"

body
string
required
Maximum string length: 1600
class
enum<string>
required
Available options:
transactional,
marketing
senderId
string

A registered alphanumeric sender id.

scheduledAt
string<date-time>

Up to 30 days ahead.

tags
string[]
Maximum array length: 10
Maximum string length: 64

Response

Queued or scheduled

id
string
required
Example:

"sm_01j9x7k2r4m8q3v5n6b7c8d9e0"

status
enum<string>
required
Available options:
queued,
scheduled
mode
enum<string>
required
Available options:
live,
test
segments
integer
required
Example:

1

credits
integer
required
Example:

1