Enviar digital

Dispara o envio por e-mail e/ou WhatsApp de um item de notificação específico.

POSThttps://external-api.arbitralis.com.br/api/external/v1/notifications/items/{itemId}/send-digital

AutenticaçãoX-API-KEYAssíncrono — o processamento continua depois da resposta

Dispara o envio digital de um item já criado. Use quando quiser controlar o momento do envio item a item, em vez de confirmar o lote inteiro.

Se você não informar o destinatário, a API usa os dados de contato da parte devedora registrada no item. O mesmo vale para os templates: sem override, valem os do lote.

Parâmetros de rota

itemIduuidobrigatório

Identificador do item de notificação.

Body

methodstringobrigatório

Canal do envio. EMAIL_WHATSAPP dispara nos dois canais.

valoresEMAILWHATSAPPEMAIL_WHATSAPP

recipientobjectopcional

Sobrescreve o contato do destinatário. Se omitido, usa o contato da parte devedora do item.

notificationTemplateIduuidopcional

Sobrescreve o template de notificação. Se omitido, usa o template do lote.

recipient

emailstringopcional

E-mail do destinatário.

phoneNumberstringopcional

Telefone do destinatário em formato internacional.

O `messageId` não é o comprovante de entrega

A resposta devolve um messageId que identifica a mensagem de processamento interna, não a entrega ao destinatário. O envio segue de forma assíncrona.

Para saber o resultado final, consulte o item pela listagem de itens do lote ou acompanhe o stream de status.

Quando usar este endpoint

O caminho padrão é criar o lote e confirmar o envio — isso dispara todos os itens de uma vez. Use o envio por item quando precisar de controle granular: reenviar para um contato alternativo, disparar só um canal, ou escalonar envios ao longo do dia.

Erros

Código	Causa
`400`	Contato, template ou dados ausentes/inválidos
`401`	API key ausente, inválida ou inativa
`404`	Item não encontrado neste workspace
`422`	Item não validado para envio digital ou cancelado
`429`	Limite de requisições excedido

Requisição

curl -X POST "https://external-api.arbitralis.com.br/api/external/v1/notifications/items/7c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f/send-digital" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: arb_live_SUA_CHAVE" \
  -d '{
    "method": "EMAIL_WHATSAPP"
  }'

const itemId = '7c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f';

const response = await fetch(
  `https://external-api.arbitralis.com.br/api/external/v1/notifications/items/${itemId}/send-digital`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-KEY': 'arb_live_SUA_CHAVE',
    },
    body: JSON.stringify({ method: 'EMAIL_WHATSAPP' }),
  }
);

const { data } = await response.json();

Resposta

{
  "success": true,
  "data": {
    "messageId": "10943812734981234"
  }
}

O messageId não é o comprovante de entrega

Erros

O `messageId` não é o comprovante de entrega