Métodos de envio permitidos

Retorna os métodos de envio habilitados no contrato da sua empresa.

GEThttps://external-api.arbitralis.com.br/api/external/v1/notifications/batches/allowed-methods

AutenticaçãoX-API-KEYSíncrono — a resposta já traz o resultado

Retorna os métodos de envio habilitados para a sua empresa. Nem todo contrato inclui todos os canais — carta física, por exemplo, costuma ser um módulo à parte.

Consulte este endpoint antes de montar telas de seleção de canal ou de tentar criar lotes com um método que pode não estar disponível.

Não há parâmetros.

Equivalência de nomenclatura

Este endpoint devolve os métodos no vocabulário interno da Arbitralis. Ao criar lotes, use o valor da coluna da esquerda:

Você envia (`deliveryMethod`)	A resposta traz
`DIGITAL`	`DIGITAL`
`EMAIL_ONLY`	`EMAIL_APENAS`
`WHATSAPP_ONLY`	`WHATSAPP_APENAS`
`PHYSICAL`	`SEDEX`
`DIGITAL_PHYSICAL`	`DIGITAL_SEDEX`

Convertendo para o formato de envio

const PARA_DELIVERY_METHOD = {
  DIGITAL: 'DIGITAL',
  EMAIL_APENAS: 'EMAIL_ONLY',
  WHATSAPP_APENAS: 'WHATSAPP_ONLY',
  SEDEX: 'PHYSICAL',
  DIGITAL_SEDEX: 'DIGITAL_PHYSICAL',
};

const disponiveis = metodos.map((metodo) => PARA_DELIVERY_METHOD[metodo]);

Método não habilitado retorna 400

Tentar criar um lote com um método fora desta lista devolve 400 — Delivery method is not enabled for this company. Se você precisa de um canal que não aparece aqui, fale com o seu contato comercial.

Erros

Código	Causa
`401`	API key ausente, inválida ou inativa
`429`	Limite de requisições excedido

Requisição

curl -X GET "https://external-api.arbitralis.com.br/api/external/v1/notifications/batches/allowed-methods" \
  -H "X-API-KEY: arb_live_SUA_CHAVE"

const response = await fetch(
  'https://external-api.arbitralis.com.br/api/external/v1/notifications/batches/allowed-methods',
  { headers: { 'X-API-KEY': 'arb_live_SUA_CHAVE' } }
);

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

if (!metodos.includes('SEDEX')) {
  console.warn('Carta física não está habilitada neste contrato');
}

import requests

response = requests.get(
    "https://external-api.arbitralis.com.br/api/external/v1/notifications/batches/allowed-methods",
    headers={"X-API-KEY": "arb_live_SUA_CHAVE"},
)

metodos = response.json()["data"]

Resposta

{
  "success": true,
  "data": ["DIGITAL", "EMAIL_APENAS", "WHATSAPP_APENAS", "SEDEX", "DIGITAL_SEDEX"]
}