Pular para o conteúdo

Engenharia4 min de leitura

Endpoints /emails da API v2 já disponíveis

Envie, consulte, atualize e cancele e-mails de forma programática com os novos endpoints de e-mail da nossa API v2.

GPor George

Endpoints /emails da API v2 já disponíveis

Temos o prazer de anunciar que os endpoints de e-mail já estão disponíveis na API v2! Agora você pode enviar e consultar e-mails, atualizar e-mails agendados e cancelar e-mails pendentes, tudo pela nossa poderosa API REST.

Novos endpoints

Enviar e-mail

POST /v2/emails

Envie um único e-mail para um ou vários destinatários. O endpoint de envio oferece suporte a:

  • Vários destinatários: envie para até 50 destinatários (TO, CC e BCC somados)
  • Templates: use aliases ou IDs de templates, com substituição de variáveis pela sintaxe {{variable}}
  • Anexos: inclua arquivos em base64 ou por URL
  • Agendamento: agende e-mails para o futuro usando ISO 8601, timestamps Unix ou linguagem natural em inglês, como “tomorrow at 9am”
  • Rastreamento: substitua as configurações padrão de rastreamento de aberturas e cliques do domínio
  • Metadados: anexe pares chave-valor personalizados, que são armazenados e retornados com o e-mail
  • Idempotência: evite envios duplicados com o cabeçalho Idempotency-Key

Ao enviar para vários endereços, cada destinatário recebe um ID de e-mail próprio, para rastreamento individual.

Consultar e-mail

GET /v2/emails/{id}

Recupere informações detalhadas sobre um e-mail específico, incluindo:

  • Status atual (pending, scheduled, sent, delivered, bounced, canceled)
  • Cabeçalhos e conteúdo bruto do e-mail
  • Configurações de rastreamento
  • Metadados personalizados
  • Timestamps de criação e de atualização

Atualizar e-mail agendado

POST /v2/emails/{id}

Reagende um e-mail programado para o futuro. Você pode mudar o horário agendado desde que faltem pelo menos 3 minutos para o envio.

Cancelar e-mail

POST /v2/emails/{id}/cancel

Cancele um e-mail agendado ou pendente antes que ele seja enviado. Para e-mails agendados, o cancelamento deve ser solicitado pelo menos 3 minutos antes do horário programado para envio.

Limites de taxa

Toda resposta inclui cabeçalhos de limite de taxa para você acompanhar o seu uso:

  • ratelimit-limit: máximo de requisições por segundo
  • ratelimit-remaining: requisições restantes no segundo atual
  • ratelimit-daily-limit: máximo de requisições por dia
  • ratelimit-daily-remaining: requisições restantes no dia

Documentação

A documentação completa, com exemplos de código em Node.js, PHP, Python, Ruby, Go, Rust, Java, .NET e cURL, já está disponível:

Em breve: API de templates

Estamos trabalhando na API de templates, que vai permitir criar, atualizar e gerenciar templates de e-mail de forma programática. Fique de olho nessa novidade!

Aviso de descontinuação da API v1

Importante: a API v1 foi descontinuada e deixará de funcionar no fim de fevereiro de 2026. Se você ainda usa a API v1, migre para a API v2 o quanto antes.

Precisa de ajuda na migração? Consulte a documentação da API v2 ou fale com a nossa equipe de suporte.

Compartilhar

Experimente o que você acabou de ler.

3.000 e-⁠mails por mês grátis. Sem cartão de crédito.

3.000 e-⁠mails por mês grátis · Sem cartão de crédito