सामग्री पर जाएं
उपयोगकर्ता गाइड कैसे करें गाइड सहायता डेमो अनुरोध करें साइन इन करें
Pushwoosh.com

ईमेल पेलोड संदर्भ

ईमेल भेजते समय Notify द्वारा उपयोग किए जाने वाले EmailPayload संदेश के लिए संदर्भ।

ईमेलपेलोड

Anchor link to
  • subject (map<string, string>): लोकेल द्वारा कुंजीबद्ध विषय पंक्ति, जैसे {"en": "Hello!", "es": "¡Hola!"}।
  • body (string): ईमेल का HTML मुख्य भाग। प्रति-लोकेल HTML मुख्य भागों के लिए, Control Panel में कॉन्फ़िगर किए गए ईमेल टेम्पलेट के साथ email_template का उपयोग करें।
  • attachments (array of Attachment): फ़ाइल अटैचमेंट।
  • list_unsubscribe (string): List-Unsubscribe हेडर के लिए कस्टम URL।
  • from (Address): ऐप की ईमेल सेटिंग्स में कॉन्फ़िगर किए गए डिफ़ॉल्ट From को ओवरराइड करें।
  • reply_to (Address): ऐप की ईमेल सेटिंग्स में कॉन्फ़िगर किए गए डिफ़ॉल्ट Reply-To को ओवरराइड करें।
  • email_template (string): इनलाइन body के बजाय उपयोग करने के लिए ईमेल टेम्पलेट का कोड।
  • email_sunset_policy (EmailSunsetPolicy): प्रोजेक्ट की सनसेट नीति इस ईमेल पर कैसे लागू होती है। यदि छोड़ दिया जाए, तो नीति लागू होती है।

EmailSunsetPolicy

Anchor link to

mode केवल तभी प्रभावी होता है जब प्रोजेक्ट के लिए सनसेट नीति चालू हो। नीति डिफ़ॉल्ट रूप से चालू नहीं होती, और जब तक वह चालू नहीं होती, दोनों मोड हर संपर्क को भेजते हैं।

{
  "mode": "EMAIL_SUNSET_MODE_OFF"
}
modeईमेल किसे मिलता है
EMAIL_SUNSET_MODE_DEFAULTकेवल सक्रिय संपर्क: निष्क्रिय संपर्क छोड़ दिए जाते हैं। email_sunset_policy को छोड़ देने के समान।
EMAIL_SUNSET_MODE_OFFसभी संपर्क, निष्क्रिय संपर्कों सहित। इसका उपयोग किसी महत्वपूर्ण मार्केटिंग ईमेल के लिए करें जो सभी तक पहुंचना चाहिए।

सनसेट नीति केवल मार्केटिंग ईमेल पर लागू होती है, इसलिए email_sunset_policy का ट्रांजैक्शनल ईमेल पर कोई प्रभाव नहीं पड़ता।

अटैचमेंट

Anchor link to
{
  "name": "invoice.pdf",
  "content": "<base64-encoded bytes>"
}
फ़ील्डप्रकारविवरण
namestringफ़ाइल का नाम जैसा प्राप्तकर्ता को दिखाई देता है।
contentstringBase64-एन्कोडेड फ़ाइल सामग्री।

पता

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

दोनों फ़ील्ड वैकल्पिक हैं। यदि name को छोड़ दिया जाता है, तो प्राप्तकर्ता को कच्चा ईमेल पता दिखाई देता है।

उदाहरण: एक सेगमेंट को ईमेल भेजें

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

उदाहरण: अटैचमेंट के साथ ट्रांजैक्शनल ईमेल

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