Passer au contenu

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

Anchor link to
  • 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.

Attachment

Anchor link to
{
"name": "invoice.pdf",
"content": "<base64-encoded bytes>"
}
ChampTypeDescription
namestringNom du fichier tel que le destinataire le voit.
contentstringContenu du fichier encodé en Base64.
{
"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

Anchor link to
Terminal window
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

Anchor link to
Terminal window
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"
}
}'