E-Mail-Payload-Referenz

Referenz für die EmailPayload-Nachricht, die von Notify beim Senden von E-Mails verwendet wird.

EmailPayload

subject (map<string, string>): Betreffzeile nach Locale verschlüsselt, z. B. {"en": "Hello!", "es": "¡Hola!"}.
body (string): HTML-Body der E-Mail. Für HTML-Bodies pro Locale verwenden Sie email_template mit einer im Control Panel konfigurierten E-Mail-Vorlage.
attachments (Array von Attachment): Dateianhänge.
list_unsubscribe (string): benutzerdefinierte URL für den List-Unsubscribe-Header.
from (Address): überschreibt das standardmäßige From, das in den E-Mail-Einstellungen der App konfiguriert ist.
reply_to (Address): überschreibt das standardmäßige Reply-To, das in den E-Mail-Einstellungen der App konfiguriert ist.
email_template (string): Code einer E-Mail-Vorlage, die anstelle eines Inline-body verwendet wird.
email_sunset_policy (EmailSunsetPolicy): wie die Sunset-Richtlinie des Projekts auf diese E-Mail angewendet wird. Wenn weggelassen, gilt die Richtlinie.

EmailSunsetPolicy

mode wirkt nur, wenn die Sunset-Richtlinie aktiviert ist für das Projekt. Die Richtlinie ist standardmäßig nicht aktiviert, und solange sie es nicht ist, senden beide Modi an alle Kontakte.

{
  "mode": "EMAIL_SUNSET_MODE_OFF"
}

`mode`	Wer die E-Mail erhält
`EMAIL_SUNSET_MODE_DEFAULT`	Nur aktive Kontakte: Inaktive Kontakte werden übersprungen. Entspricht dem Weglassen von `email_sunset_policy`.
`EMAIL_SUNSET_MODE_OFF`	Alle Kontakte, einschließlich inaktiver. Verwenden Sie diesen Modus für eine wichtige Marketing-E-Mail, die alle erreichen muss.

Die Sunset-Richtlinie gilt nur für Marketing-E-Mails, daher hat email_sunset_policy keine Wirkung auf Transaktions-E-Mails.

Attachment

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

Feld	Typ	Beschreibung
`name`	string	Dateiname, wie ihn der Empfänger sieht.
`content`	string	Base64-kodierter Dateiinhalt.

Address

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

Beide Felder sind optional. Wenn name weggelassen wird, sieht der Empfänger die reine E-Mail-Adresse.

Beispiel: Senden einer E-Mail an ein Segment

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

Beispiel: Transaktions-E-Mail mit Anhang

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