Appearance
Introdução
Esta é a referência da API REST do ViaPost — para desenvolvedores que integram envio de e-mail transacional/marketing, gestão de domínios, observabilidade de mensagens, recebimento de e-mail (inbound) e webhooks.
Base URL
https://api.viapost.ioO que a API permite fazer hoje
- Enviar e-mail transacional ou de marketing (
POST /v1/send) - Gerenciar domínios remetentes e DKIM — registrar, verificar, rotacionar chave, remover
- Consultar mensagens enviadas — status, eventos, métricas agregadas
- Consultar e-mails recebidos — inbound parsing com anexos
- Configurar webhooks para receber eventos em tempo real
Veja também: Autenticação, Erros, Paginação e rate limiting.
Limitações atuais
- Não há endpoint para o cliente listar ou gerenciar supressões manualmente (bounce, complaint, unsubscribe) — supressões são aplicadas automaticamente com base em eventos de entrega, e checadas silenciosamente a cada envio.
- Não há suporte a templates — o corpo do e-mail (
html/text) é sempre enviado inline no corpo da requisição de envio. - Não há endpoint de "campanhas" — envio para múltiplos destinatários é feito com o campo
to(lista) emPOST /v1/send. - Chaves de API (API Keys) são criadas e gerenciadas apenas pelo painel (dashboard); o endpoint de gestão de chaves exige sessão de usuário logado e rejeita explicitamente autenticação via API Key, então não há como criar/revogar chaves usando uma API Key existente.