Référence du payload d'e-mail

Référence pour le message EmailPayload utilisé par Notify lors de l’envoi d’un e-mail.

EmailPayload

subject (map<string, string>) : ligne d’objet indexée par locale, par ex. {"en": "Hello!", "es": "¡Hola!"}.
body (string) : corps HTML de l’e-mail. Pour des corps HTML par locale, utilisez email_template avec un modèle d’e-mail configuré dans le Control Panel.
attachments (tableau de Attachment) : pièces jointes.
list_unsubscribe (string) : URL personnalisée pour l’en-tête List-Unsubscribe.
from (Address) : remplace le From par défaut configuré dans les paramètres d’e-mail de l’application.
reply_to (Address) : remplace le Reply-To par défaut configuré dans les paramètres d’e-mail de l’application.
email_template (string) : code d’un modèle d’e-mail à utiliser à la place d’un body en ligne.
email_sunset_policy (EmailSunsetPolicy) : la manière dont la politique d’inactivité du projet s’applique à cet e-mail. Si le champ est omis, la politique s’applique.

EmailSunsetPolicy

mode ne prend effet que lorsque la politique d’inactivité est activée pour le projet. La politique n’est pas activée par défaut et, tant qu’elle ne l’est pas, les deux modes envoient à tous les contacts.

{
  "mode": "EMAIL_SUNSET_MODE_OFF"
}

`mode`	Qui reçoit l’e-mail
`EMAIL_SUNSET_MODE_DEFAULT`	Uniquement les contacts actifs : les contacts inactifs sont ignorés. Équivaut à omettre `email_sunset_policy`.
`EMAIL_SUNSET_MODE_OFF`	Tous les contacts, y compris les inactifs. Utilisez-le pour un e-mail marketing important qui doit atteindre tout le monde.

La politique d’inactivité s’applique uniquement aux e-mails marketing, donc email_sunset_policy n’a aucun effet sur les e-mails transactionnels.

Attachment

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

Champ	Type	Description
`name`	string	Nom du fichier tel que le destinataire le voit.
`content`	string	Contenu du fichier encodé en Base64.

Address

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

Les deux champs sont facultatifs. Si name est omis, le destinataire voit l’adresse e-mail brute.

Exemple : Envoyer un e-mail à un 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"
    }
  }'

Exemple : E-mail transactionnel avec pièce jointe

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