Skip to main content
POST

Authorizations

Authorization
string
header
required

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Headers

Idempotency-Key
string

Unique key to prevent duplicate sends. Alternative: x-idempotency-key.

x-idempotency-key
string

Unique idempotency key (alternative to Idempotency-Key).

Body

application/json
to
string[]
required

One or more phone numbers in international format (e.g. 5511999999999).

Required array length: 1 - 100 elements
type
enum<string>
required

Use text for a free-form message or template for a workspace template.

Available options:
text,
template
payload
object
required

Message body: plain text or template data (ID and variables).

schedule
object
options
object
metadata
object

Metadados string→string por envio, persistidos em SmsLog.metadata. Respeite os limites de payload da API.

Response

SMS accepted and queued for immediate or scheduled delivery.

success
boolean
required
Example:

true

data
object
required