Referencia del payload de email

Referencia para el mensaje EmailPayload utilizado por Notify al enviar un email.

EmailPayload

subject (map<string, string>): línea de asunto por configuración regional, p. ej., {"en": "Hello!", "es": "¡Hola!"}.
body (string): cuerpo HTML del email. Para cuerpos HTML por configuración regional, use email_template con una Plantilla de Email configurada en el Panel de Control.
attachments (array de Attachment): archivos adjuntos.
list_unsubscribe (string): URL personalizada para la cabecera List-Unsubscribe.
from (Address): sobrescribe el From por defecto configurado en los ajustes de email de la aplicación.
reply_to (Address): sobrescribe el Reply-To por defecto configurado en los ajustes de email de la aplicación.
email_template (string): código de una Plantilla de Email para usar en lugar de un body en línea.
email_sunset_policy (EmailSunsetPolicy): cómo se aplica la política de sunset del proyecto a este email. Si se omite, la política se aplica.

EmailSunsetPolicy

mode solo tiene efecto cuando la política de sunset está activada para el proyecto. La política no está activada por defecto y, hasta que se active, ambos modos envían a todos los contactos.

{
  "mode": "EMAIL_SUNSET_MODE_OFF"
}

`mode`	Quién recibe el email
`EMAIL_SUNSET_MODE_DEFAULT`	Solo los contactos activos: los contactos inactivos se omiten. Equivale a omitir `email_sunset_policy`.
`EMAIL_SUNSET_MODE_OFF`	Todos los contactos, incluidos los inactivos. Úselo para un email de marketing importante que debe llegar a todos.

La política de sunset se aplica solo a los emails de marketing, por lo que email_sunset_policy no tiene efecto en los emails transaccionales.

Attachment

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

Campo	Tipo	Descripción
`name`	string	Nombre del archivo tal como lo ve el destinatario.
`content`	string	Contenido del archivo codificado en Base64.

Address

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

Ambos campos son opcionales. Si se omite name, el destinatario ve la dirección de email sin formato.

Ejemplo: Enviar un email a un 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"
    }
  }'

Ejemplo: Email transaccional con archivo adjunto

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