# Referência de payload de e-mail

Referência para a mensagem `EmailPayload` usada por [`Notify`](/pt/developer/api-reference/messaging-api-v2/notify/) ao enviar e-mails.

<Aside type="note">
Para payloads de push / SMS / messenger, consulte a [Referência de payload](/pt/developer/api-reference/messaging-api-v2/payload-reference/).
</Aside>

## EmailPayload

- `subject` (map&lt;string, string&gt;): 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](/pt/product/content/email-content/) configurado no Painel de Controle.
- `attachments` (array de [`Attachment`](#attachment)): anexos de arquivo.
- `list_unsubscribe` (string): URL personalizada para o cabeçalho `List-Unsubscribe`.
- `from` ([`Address`](#address)): substitui o `From` padrão configurado nas configurações de e-mail do aplicativo.
- `reply_to` ([`Address`](#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](/pt/product/content/email-content/) para usar em vez de um `body` embutido.

## Attachment

```json
{
  "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

```json
{
  "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

```bash
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

```bash
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"
    }
  }'
```