Skip to main content
POST
Enviar lote de mensagens

Authorizations

Authorization
string
header
required

Chave de API da Arara (ara_live_...), enviada no header Authorization: Bearer ara_live_.... Crie e gerencie as chaves no painel: https://app.ararahq.com/dashboard/apikeys. O valor completo aparece uma única vez, na criação.

Headers

Idempotency-Key
string

Chave de idempotência, de 1 a 255 caracteres, sem caracteres de controle (fora disso: 400 INVALID_IDEMPOTENCY_KEY). Derive de um evento do seu sistema (id do pedido, id da tentativa) e reuse a mesma chave nas retentativas.

Maximum string length: 255

Body

application/json
templateName
string
required

Nome do template aprovado, igual para todo o lote.

messages
object[]
required

De 1 a 1.000 destinatários.

Required array length: 1 - 1000 elements

Response

Lote aceito

batchId
string
required

Use em GET /v1/messages?batchId= para acompanhar o lote.

templateName
string
required
total
integer
required

Destinatários recebidos.

accepted
integer
required

Mensagens aceitas para envio.

totalCost
number
required

Custo total em reais.

messages
object[]
required