Skip to content

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.io

O que a API permite fazer hoje

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) em POST /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.