Skip to main content
POST
Send an SMS

Authorizations

Authorization
string
header
required

Your API key (as_live_…), created under Settings → API keys.

Body

application/json
to
string
required

Destination phone in E.164.

Example:

"+15551234567"

body
string
required

The message text.

Example:

"Hi {first_name}! Your code is 4821."

from
string

Sending number — an E.164 number or a number id. Omit to send from a pool or your workspace default.

Example:

"+12025551234"

pool
string

DID pool to send from, by name or id — the system rotates a number from the pool. Ignored when from is set. Omit both from and pool to use your workspace default pool (a pool named "Default", otherwise any of your numbers).

Example:

"Transactional"

destination_url
string

Attach a tracked short link to this URL. It's minted as a click-tracked short link (same as campaign/flow links) and placed in the message — replacing a {link} token in body, or appended when there's no token. The response returns the short URL in link.short_url. {click_id} in the URL is substituted at click time.

Example:

"https://acme.com/track/order/abc123"

Which tracking domain to build the short link on — a link domain name, id, or hostname. Omit to use the workspace's newest active tracking domain. Only used with destination_url.

Example:

"go.acme.com"

Response

The SMS was accepted for delivery.

ok
boolean
Example:

true

message
object