Referência de payload de e-mail

Referência para a mensagem EmailPayload usada por Notify ao enviar e-mails.

EmailPayload

subject (map<string, string>): linha de assunto por localidade, por exemplo, {"en": "Hello!", "es": "¡Hola!"}.
body (string): corpo HTML do e-mail. Para corpos HTML por localidade, use email_template com um Modelo de E-mail configurado no Painel de Controle.
attachments (array de Attachment): anexos de arquivo.
list_unsubscribe (string): URL personalizada para o cabeçalho List-Unsubscribe.
from (Address): substitui o From padrão configurado nas configurações de e-mail do aplicativo.
reply_to (Address): substitui o Reply-To padrão configurado nas configurações de e-mail do aplicativo.
email_template (string): código de um Modelo de E-mail para usar em vez de um body embutido.
email_sunset_policy (EmailSunsetPolicy): como a política de sunset do projeto se aplica a este e-mail. Se omitido, a política se aplica.

EmailSunsetPolicy

mode só tem efeito quando a política de sunset está ativada para o projeto. A política não vem ativada por padrão e, até que seja ativada, ambos os modos enviam para todos os contatos.

{
  "mode": "EMAIL_SUNSET_MODE_OFF"
}

`mode`	Quem recebe o e-mail
`EMAIL_SUNSET_MODE_DEFAULT`	Apenas contatos ativos: os contatos inativos são ignorados. Equivale a omitir `email_sunset_policy`.
`EMAIL_SUNSET_MODE_OFF`	Todos os contatos, incluindo os inativos. Use-o para um e-mail de marketing importante que precisa chegar a todos.

A política de sunset se aplica apenas a e-mails de marketing, portanto email_sunset_policy não tem efeito em e-mails transacionais.

Attachment

{
  "name": "invoice.pdf",
  "content": "<base64-encoded bytes>"
}

Campo	Tipo	Descrição
`name`	string	Nome do arquivo como o destinatário o vê.
`content`	string	Conteúdo do arquivo codificado em Base64.

Address

{
  "name":  "Pushwoosh",
  "email": "support@example.com"
}

Ambos os campos são opcionais. Se name for omitido, o destinatário verá o endereço de e-mail bruto.

Exemplo: Enviar um e-mail para um segmento

curl -X POST https://api.pushwoosh.com/messaging/v2/notify \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "segment": {
      "application": "XXXXX-XXXXX",
      "platforms": ["EMAIL"],
      "code": "newsletter_subscribers",
      "email_payload": {
        "subject": { "en": "Our May updates", "es": "Novedades de mayo" },
        "email_template": "may-digest-2026",
        "from":     { "name": "Pushwoosh Team", "email": "news@example.com" },
        "reply_to": { "email": "replies@example.com" }
      },
      "schedule": { "at": "2026-05-01T09:00:00Z" },
      "message_type": "MESSAGE_TYPE_MARKETING"
    }
  }'

Exemplo: E-mail transacional com anexo

curl -X POST https://api.pushwoosh.com/messaging/v2/notify \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "transactional": {
      "application": "XXXXX-XXXXX",
      "platforms": ["EMAIL"],
      "users": { "list": ["customer-42"] },
      "email_payload": {
        "subject": { "en": "Your invoice" },
        "body":    "<p>Please find your invoice attached.</p>",
        "attachments": [
          { "name": "invoice.pdf", "content": "JVBERi0xLjQKJe..." }
        ]
      },
      "schedule": { "at": "2026-05-01T12:00:00Z" },
      "message_type": "MESSAGE_TYPE_TRANSACTIONAL"
    }
  }'