Skip to main content
POST

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

Idempotency-Key
string

Chave única para evitar envio duplicado. Alternativa: x-idempotency-key.

x-idempotency-key
string

Chave única para idempotência (alternativa a Idempotency-Key).

Corpo

application/json
to
string[]
obrigatório

Um ou mais números no formato internacional (ex.: 5511999999999).

Required array length: 1 - 100 elements
type
enum<string>
obrigatório

Escolha text para mensagem livre ou template para usar um template do workspace.

Opções disponíveis:
text,
template
payload
object
obrigatório

Corpo da mensagem: texto livre ou dados do template (ID e variáveis).

schedule
object
options
object
metadata
object

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

Resposta

SMS aceito(s). Enfileirado(s) para envio imediato ou agendado.

success
boolean
obrigatório
Exemplo:

true

data
object
obrigatório