curl --request POST \
--url https://api.ararahq.com/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"name": "Black Friday 2026",
"templateName": "bf_oferta_geral",
"contacts": [
{
"to": "+5511999999999",
"variables": [
"João",
"30"
]
},
{
"to": "+5511888888888",
"variables": [
"Maria",
"25"
]
}
]
}
'{
"id": "7b3789fb-4c5d-6789-abcd-ef0123456789",
"name": "Black Friday 2026",
"status": "INGESTING",
"totalMessages": 2,
"totalCost": 0.767,
"scheduledAt": null
}Criar campanha
Cria a campanha, valida template e variáveis, reserva a cota do plano e debita o custo total da carteira antes de enfileirar. Os envios rodam em segundo plano. Contatos bloqueados no envio (opt-out, número inválido, limite de frequência) são estornados um a um.
Idempotency-Keyé obrigatório. Repetir a chave devolve a campanha já criada, sem cobrar de novo. A unicidade da chave é global na Arara, não por organização: derive do identificador da campanha no seu sistema, com um prefixo só seu (ex.acme-campanha-8842).scheduledAtagenda o envio, entre 5 minutos e 30 dias à frente. A campanha nasceSCHEDULED, já cobrada. Fora da janela:400 CAMPAIGN_SCHEDULE_TOO_SOONou400 CAMPAIGN_SCHEDULE_TOO_FAR.abTestcria o teste A/B junto com a campanha.templateNameé a variante A.
Pré-requisitos: número dedicado conectado (403 NO_DEDICATED_NUMBER), saldo
para o total (402 INSUFFICIENT_FUNDS) e cota do plano
(403 PLAN_LIMIT_REACHED).
Permissão: CAMPAIGNS_SEND.
curl --request POST \
--url https://api.ararahq.com/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"name": "Black Friday 2026",
"templateName": "bf_oferta_geral",
"contacts": [
{
"to": "+5511999999999",
"variables": [
"João",
"30"
]
},
{
"to": "+5511888888888",
"variables": [
"Maria",
"25"
]
}
]
}
'{
"id": "7b3789fb-4c5d-6789-abcd-ef0123456789",
"name": "Black Friday 2026",
"status": "INGESTING",
"totalMessages": 2,
"totalCost": 0.767,
"scheduledAt": null
}Authorizations
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
Identificador único da campanha. Derive do identificador da campanha no seu sistema (ex. acme-campanha-8842) e reuse a mesma chave nas retentativas. A unicidade é global na Arara.
255Body
Nome interno da campanha.
Nome ou ID do template aprovado. Com abTest, é a variante A.
Destinatários, no mínimo 1.
1Show child attributes
Show child attributes
Número que envia. Omitido, usa o padrão da organização.
Show child attributes
Show child attributes
Agenda o envio (ISO 8601), entre 5 minutos e 30 dias no futuro.
Response
Campanha criada (ou existente, se a chave já foi usada)
SCHEDULED: agendada, aguardando o horário.INGESTING: processando contatos e enfileirando envios.AB_TESTING: teste A/B em andamento.COMPLETED: todos os contatos processados.COMPLETED_WITH_ERRORS: processada, com contatos bloqueados.FAILED: falha geral no processamento.CANCELED: cancelada.
SCHEDULED, INGESTING, AB_TESTING, COMPLETED, COMPLETED_WITH_ERRORS, FAILED, CANCELED Valor já debitado da carteira, em reais. Os valores dos exemplos são ilustrativos.