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.

Body

application/json
from
string
required

A valid alphanumeric sender ID on the user's account.

Example:

"MyCompany"

to
string
required

Receiving address (+E.164 formatted phone number).

Example:

"+E.164"

text
string
required

The message body.

messaging_profile_id
string<uuid>
required

The messaging profile ID to use.

webhook_url
string<url> | null

Callback URL for delivery status updates.

webhook_failover_url
string<url> | null

Failover callback URL for delivery status updates.

use_profile_webhooks
boolean

If true, use the messaging profile's webhook settings.

Response

Successful response with the sent message.

data
object
Example: