Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores. Generate a unique UUID v4 for each operation and reuse it only when retrying that operation with the same request. Invalid headers—including duplicate, empty, malformed, or overlong values—return 400 with error code 10015. A request already in progress with the same key returns 409; reusing the key with a different request returns 422. Only successful responses are replayed, for up to 24 hours. Do not include sensitive data in the key.

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

Body

application/json

Message payload

to
string
required

Receiving address (+E.164 formatted phone number or short code).

Example:

"+E.164"

from
string

Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).

Required if sending with a phone number, short code, or alphanumeric sender ID.

messaging_profile_id
string

Unique identifier for a messaging profile.

Required if sending via number pool or with an alphanumeric sender ID.

text
string

Message body (i.e., content) as a non-empty string.

Required for SMS

subject
string

Subject of multimedia message

media_urls
string<url>[]

A list of media URLs. The total media size must be less than 1 MB.

Required for MMS

webhook_url
string<url>

The URL where webhooks related to this message will be sent.

webhook_failover_url
string<url>

The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.

use_profile_webhooks
boolean
default:true

If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile.

type
enum<string>

The protocol for sending the message, either SMS or MMS.

Available options:
SMS,
MMS
auto_detect
boolean
default:false

Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts.

send_at
string<date-time> | null

ISO 8601 formatted date indicating when to send the message - accurate up till a minute.

encoding
enum<string>
default:auto

Encoding to use for the message. auto (default) uses smart encoding to automatically select the most efficient encoding. gsm7 forces GSM-7 encoding (returns 400 if message contains characters that cannot be encoded). ucs2 forces UCS-2 encoding and disables smart encoding. When set, this overrides the messaging profile's smart_encoding setting.

Available options:
auto,
gsm7,
ucs2

Response

Successful response with details about a message.

data
object
Example: