Skip to main content

O que é

A API de e-mail envia um e-mail para um ou mais destinatários. Use-a para notificações transacionais, atualizações de conta, recibos e mensagens personalizadas.

Antes de começar

  • Armazene sua chave de API da YCloud em YCLOUD_API_KEY.
  • Registre e ative o domínio remetente na sua conta YCloud.
  • Use um endereço de remetente do domínio ativado.
  • Prepare conteúdo em HTML ou texto simples com no máximo 150 KB.

Como funciona

Envie o e-mail com POST /emails. A resposta confirma que a YCloud aceitou o e-mail e retorna seu id. A entrega ocorre separadamente para cada endereço em to, cc e bcc. Inscreva-se em email.delivery.updated para receber estados por destinatário como sent, delivered, undelivered e failed.

Requisição

POST /emails

Campos da requisição

Exemplo de requisição

Resposta

Uma resposta bem-sucedida retorna o objeto de e-mail criado. A aceitação não significa que todos os destinatários receberam o e-mail.

Exemplo de resposta

Campos da resposta

Personalizar o conteúdo

Coloque as variáveis entre caracteres # no conteúdo. Forneça um objeto de variáveis para cada endereço em to.

Status de entrega

Inscreva-se em email.delivery.updated. Cada evento identifica o e-mail e o recipientAddress específico, porque os destinatários podem ter estados finais diferentes. Mensagens text/plain não geram eventos de rastreamento de cliques ou aberturas.

Limites e solução de problemas

  • O domínio remetente deve estar ativado antes do envio.
  • to suporta no máximo 100 endereços.
  • subject suporta no máximo 255 caracteres.
  • content suporta no máximo 150 KB.
  • Uma resposta bem-sucedida da API ainda pode ser seguida por um evento undelivered ou failed de um destinatário.
  • Use o id do e-mail, o endereço do destinatário e externalId ao investigar a entrega.