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

from
string
required

Phone number, in +E.164 format, used to send the message.

to
string[]
required

A list of destinations. No more than 8 destinations are allowed.

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

text
string

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

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.

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.

Response

Successful response with details about a message.

data
object
Example: