Skip to main content
The API Key is your access card: each scope opens one door. In production, grant only what your integration needs.

​
In brief

  • sms:* scopes cover send, read, and cancel.
  • SMS does not use instances, there is no instanceIds on this channel.
  • General guide: API Keys. First send: Quick Start.

​
How to send the key

Alternative: x-api-key: sk_live_xxxxx.
An empty scope list on create = ADMIN access (everything). Always restrict in production.

​
Ready-made combinations

Send only

sms:send

Send and query

sms:send, sms:read

With scheduling

sms:send, sms:cancel

Full flow

sms:send, sms:read, sms:cancel

​
Available scopes

Send immediate or scheduled SMS (POST /v1/sms/messages).
List sent messages, query by id, and inbound MO.
Cancel scheduled (SCHEDULED), credits refunded.

​
Common errors

Full catalog: Error responses (SMS accordion).

​
Next steps