> ## Documentation Index > Fetch the complete documentation index at: https://docs.ararahq.com/llms.txt > Use this file to discover all available pages before exploring further. # Enviar lote de mensagens > Envia o mesmo template para até 1.000 destinatários em uma chamada. Para mais que isso, use Campanhas. O lote é tudo ou nada: um telefone inválido ou saldo insuficiente recusa o lote inteiro com `422 UNPROCESSABLE_ENTITY`. Com `Idempotency-Key`, repetir a chamada devolve o lote original sem reenviar. Acompanhe o lote em `GET /v1/messages?batchId=`. Permissão: `MESSAGES_SEND`. ## OpenAPI ````yaml /openapi.yaml post /v1/messages/batch openapi: 3.0.3 info: title: API da Arara description: > API REST da Arara para WhatsApp Business: mensagens, templates, campanhas, contatos, conversas, formulários, automações, smart links e carteira. Esta especificação cobre só os endpoints que aceitam **chave de API** (`Authorization: Bearer ara_live_...`). Rotas usadas apenas pelo painel (gestão de chaves, configuração do webhook, pagamentos e perfil pessoal) ficam de fora. ## Autenticação Header `Authorization: Bearer ara_live_...`. Crie a chave em https://app.ararahq.com/dashboard/apikeys. As chaves são sempre LIVE: mensagens são entregues de verdade e o custo sai da carteira. ## Permissões da chave Chave criada sem permissões explícitas tem acesso total (`ADMIN`). Chave com permissões restritas só alcança: - `READ`: `GET` em `/v1/messages`, `/v1/campaigns`, `/v1/templates`, `/v1/flows`, `/v1/automations` e `/v1/organizations/me/numbers`. - `MESSAGES_SEND`: escrita em `/v1/messages/**`, `POST /v1/media/upload` e `POST /v1/flows/{id}/test`. - `TEMPLATES_WRITE`: escrita em `/v1/templates/**` e `/v1/flows/**`. - `CAMPAIGNS_SEND`: escrita em `/v1/campaigns/**`. - `CONTACTS_WRITE`: escrita em `/v1/contacts/**`. - `AUTOMATIONS_MANAGE`: escrita em `/v1/automations/**`. - `WEBHOOKS_MANAGE`: escrita em `/webhook/**`. Qualquer outra rota exige `ADMIN`. Fora do escopo, a resposta é `403`. ## Rate limit Por usuário da chave: 1.200 leituras (`GET`) por minuto e 3.000 escritas por minuto. Toda resposta traz `X-RateLimit-Remaining`. Acima do limite: `429` com `Retry-After` e `error.code = RATE_LIMIT_EXCEEDED`. O envio tem limites próprios (`SEND_RATE_LIMITED`, `BATCH_BUSY`, `MARKETING_FREQUENCY_EXCEEDED`). ## Formato de erro ```json { "error": { "code": "ERROR_CODE", "message": "Descrição", "details": {} } } ``` Exceções: falha de autenticação (`401`, `403` e `503` do filtro de chave) volta no formato padrão do Spring (`timestamp`, `status`, `error`, `path`, sem `code`), e alguns `404` e `403` voltam sem corpo. version: 2.1.0 contact: name: AraraHQ url: https://ararahq.com email: oi@ararahq.com servers: - url: https://api.ararahq.com description: Produção security: - bearerAuth: [] tags: - name: Mensagens description: Envio, consulta e histórico de mensagens de WhatsApp, e upload de mídia. - name: Conversas description: >- Conversas com cada telefone, resposta dentro da janela de 24h e situação da janela. - name: Templates description: Criação, listagem, status de aprovação e métricas de templates. - name: Campanhas description: >- Envio do mesmo template para muitos contatos, com estimativa, agendamento, cancelamento e teste A/B. - name: Contatos description: Base de contatos da organização e direitos do titular (LGPD). - name: Opt-out description: Registro e consulta de quem pediu para não receber mensagens. - name: Formulários description: >- Formulários nativos do WhatsApp (Flows) e as respostas recebidas. Disponíveis do plano Voo para cima. - name: Automações description: >- Sequências de passos que rodam sozinhas para cada contato que entra por um gatilho. Exigem plano com recuperação de receita. - name: Smart Links description: Links wa.me rastreáveis, com QR code. - name: Números description: >- Números de WhatsApp da organização e o perfil comercial exibido no WhatsApp. - name: Carteira description: Saldo, extrato, recarga automática e preços. - name: Consulta de telefone description: Consulta de tipo de linha e de WhatsApp de um número (cobrada). - name: Recuperação description: Endpoint de recuperação de receita (carrinho abandonado, Pix, boleto). - name: Conta description: Identidade da chave, plano da organização e status da API. paths: /v1/messages/batch: post: tags: - Mensagens summary: Enviar lote de mensagens description: > Envia o mesmo template para até 1.000 destinatários em uma chamada. Para mais que isso, use Campanhas. O lote é tudo ou nada: um telefone inválido ou saldo insuficiente recusa o lote inteiro com `422 UNPROCESSABLE_ENTITY`. Com `Idempotency-Key`, repetir a chamada devolve o lote original sem reenviar. Acompanhe o lote em `GET /v1/messages?batchId=`. Permissão: `MESSAGES_SEND`. operationId: sendBatchMessages parameters: - $ref: '#/components/parameters/IdempotencyKeyOptional' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchMessageRequest' example: templateName: pedido_confirmado messages: - receiver: '+5511999999999' templateVariables: - João - '1' - receiver: '+5511888888888' templateVariables: - Maria - '2' responses: '202': description: Lote aceito content: application/json: schema: $ref: '#/components/schemas/BatchMessageResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '409': description: > - `CONFLICT`: template não encontrado na organização. - `PROVIDER_NOT_RESOLVED`: o número de envio não está pronto para enviar. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: CONFLICT message: Template 'pedido_confirmado' não encontrado. details: {} '422': description: >- `UNPROCESSABLE_ENTITY`: algum telefone inválido ou saldo insuficiente para o lote. Nada é enviado. Também os códigos de template (`TEMPLATE_PAUSED`, `TEMPLATE_NOT_SENDABLE`, `TEMPLATE_VARIABLES_MISMATCH`). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: UNPROCESSABLE_ENTITY message: Saldo insuficiente para o lote. details: {} '429': $ref: '#/components/responses/TooManyRequests' components: parameters: IdempotencyKeyOptional: in: header name: Idempotency-Key required: false schema: type: string maxLength: 255 description: >- 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. example: pedido-12345-confirmacao schemas: BatchMessageRequest: type: object required: - templateName - messages properties: templateName: type: string description: Nome do template aprovado, igual para todo o lote. messages: type: array minItems: 1 maxItems: 1000 items: $ref: '#/components/schemas/BatchMessageItem' description: De 1 a 1.000 destinatários. BatchMessageResponse: type: object required: - batchId - templateName - total - accepted - totalCost - messages properties: batchId: type: string description: Use em `GET /v1/messages?batchId=` para acompanhar o lote. templateName: type: string total: type: integer description: Destinatários recebidos. accepted: type: integer description: Mensagens aceitas para envio. totalCost: type: number description: Custo total em reais. messages: type: array items: $ref: '#/components/schemas/BatchMessageItemResponse' example: batchId: ara_msg_b7C1d2E templateName: pedido_confirmado total: 2 accepted: 2 totalCost: 0.136 messages: - id: ara_msg_a1B2c3D receiver: whatsapp:+5511999999999 status: PENDING cost: 0.068 - id: ara_msg_e4F5g6H receiver: whatsapp:+5511888888888 status: PENDING cost: 0.068 Error: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string example: INSUFFICIENT_FUNDS description: >- Código estável do erro. Use este campo no seu tratamento, não a mensagem. message: type: string nullable: true description: Descrição legível, em português. Pode mudar. details: type: object additionalProperties: true description: Dados extras do erro. Vazio na maioria dos casos. example: error: code: INSUFFICIENT_FUNDS message: Saldo insuficiente. details: {} BatchMessageItem: type: object required: - receiver properties: receiver: type: string description: Telefone do destinatário, E.164 com `+`. example: '+5511999999999' templateVariables: type: array nullable: true items: type: string description: >- Variáveis posicionais deste destinatário. Aceita o alias `variables`. smartLinkParam: type: string nullable: true description: Parâmetro do botão de smart link do template. smartLinkUrl: type: string nullable: true description: URL de destino do botão de smart link do template. mediaUrl: type: string nullable: true description: URL da mídia do cabeçalho para este destinatário. BatchMessageItemResponse: type: object required: - receiver - status properties: id: type: string nullable: true receiver: type: string status: type: string cost: type: number nullable: true SpringError: type: object description: >- Corpo padrão do Spring nas falhas de autenticação (`401`, `403` e `503` do filtro de chave). Não tem `error.code`. properties: timestamp: type: string format: date-time status: type: integer example: 401 error: type: string example: Unauthorized path: type: string example: /v1/messages responses: BadRequest: description: >- Requisição inválida: `VALIDATION_ERROR` (campo obrigatório ausente ou regra do corpo), `INVALID_JSON` (JSON malformado ou tipo errado), `INVALID_PATH_PARAM` ou `INVALID_IDEMPOTENCY_KEY`. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: VALIDATION_ERROR message: O número do recebedor é obrigatório details: {} Unauthorized: description: > Chave inexistente, revogada, expirada, com prefixo errado (`ara_` sem `ara_live_`) ou vinda de IP fora da allowlist. O corpo é o JSON padrão do Spring, sem `error.code`. content: application/json: schema: $ref: '#/components/schemas/SpringError' example: timestamp: '2026-09-15T14:30:00.000+00:00' status: 401 error: Unauthorized path: /v1/messages Forbidden: description: > Dois casos, com corpos diferentes: - Autenticação: header `Authorization` ausente, Bearer que não começa com `ara_`, chave sem a permissão da rota ou rota que não aceita chave de API. Corpo no formato padrão do Spring, sem `error.code`. - Regra de negócio, no formato `{ "error": { ... } }`: `PLAN_FEATURE_LOCKED`, `PLAN_LIMIT_REACHED`, `ACCOUNT_NOT_ACTIVATED`, `NO_DEDICATED_NUMBER`, `ORGANIZATION_SUSPENDED`, `NUMBER_BLOCKED`, `FRAUD_SUSPECTED`, `RESOURCE_FORBIDDEN`, `VIEWER_READ_ONLY`. content: application/json: schema: anyOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/SpringError' examples: regraDeNegocio: summary: Regra de negócio value: error: code: PLAN_FEATURE_LOCKED message: Seu plano não inclui este recurso. details: {} autenticacao: summary: Sem header ou sem permissão value: timestamp: '2026-09-15T14:30:00.000+00:00' status: 403 error: Forbidden path: /v1/messages TooManyRequests: description: > Limite atingido: - `RATE_LIMIT_EXCEEDED`: limite geral da API. Traz `Retry-After` e `X-RateLimit-Remaining`. - `SEND_RATE_LIMITED`: teto de envio, inclusive o limite diário da chave. Traz `Retry-After`. - `BATCH_BUSY`: já existe um lote em processamento. Traz `Retry-After`. - `MARKETING_FREQUENCY_EXCEEDED`: o contato já recebeu marketing demais na janela. **Não** traz `Retry-After`. headers: Retry-After: schema: type: integer description: >- Segundos a aguardar antes de repetir a chamada, com a mesma `Idempotency-Key`. Ausente em `MARKETING_FREQUENCY_EXCEEDED`. X-RateLimit-Remaining: schema: type: integer description: >- Requisições restantes na janela atual. Presente em `RATE_LIMIT_EXCEEDED`. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: SEND_RATE_LIMITED message: Limite de envio atingido. Tente de novo em instantes. details: {} securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: ara_live_... description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.