Skip to main content
POST
Send an SMS

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Body

application/json
from_number_id
string<uuid>
required

ID of an SMS-capable phone number with outbound SMS enabled.

to
string
required

Recipient in E.164 format.

Example:

"+14155550100"

body
string
required

Message body.

Required string length: 1 - 1600

Response

SMS accepted.

data
object
required