Zinn® Campaigns API और MCP: डेवलपर गाइड

डैशबोर्ड पर आप Zinn® Campaigns में जो कुछ भी कर सकते हैं, वह सब API के माध्यम से भी किया जा सकता है, और इसमें से अधिकांश MCP के ज़रिए आपके खाते से जुड़े AI सहायक से भी किया जा सकता है। यह मार्गदर्शिका साइन इन करने, अनुमतियों, दोनों तरीकों से एक व्यावहारिक उदाहरण, सीमाओं, त्रुटियों और सभी 89 Campaigns परिचालनों को शामिल करती है। नीचे दी गई परिचालन सूची हमारे API विनिर्देश से तैयार की गई है, इसलिए यह हमेशा API की कार्यप्रणाली से मेल खाती है। प्रत्येक परिचालन का प्रत्येक फ़ील्ड zinndigital.com/developers/api/zinn-campaigns पर API संदर्भ में उपलब्ध है।

साइन इन करना

• API कुंजियाँ। डैशबोर्ड में सेटिंग्स → API कुंजियाँ के अंतर्गत एक कुंजी बनाएँ और इसे Authorization: Bearer zdk_live_… के रूप में भेजें (एक zdk_test_… कुंजी सैंडबॉक्स मोड में काम करती है)। कुंजी को केवल वे ही Campaigns अनुमतियाँ दें जिनकी उसे आवश्यकता है और उससे अधिक कुछ नहीं।
• AI सहायक (MCP)। Claude, ChatGPT, Cursor या किसी भी MCP क्लाइंट को https://api.zinndigital.com/v1/mcp से कनेक्ट करें, या तो ऐप से साइन इन करके या कनेक्शन टोकन (zmcp_live_…) के साथ। अपने खाते से Claude, Cursor या ChatGPT कनेक्ट करना देखें। सहमति स्क्रीन पर, Zinn® Campaigns अनुमतियों पर सही का निशान लगाएँ।
• अनुमतियाँ। email_marketing.view अभियानों, सूचियों, संपर्कों, फ़ॉर्मों, प्रेषकों, SMS सेटिंग्स और रिपोर्टों को पढ़ता है; email_marketing.manage उन्हें बनाता और बदलता है। जो अभियान आप अपनी स्वयं की ईमेल सेवा के माध्यम से भेजते हैं, वे campaigns.view और campaigns.manage का उपयोग करते हैं।
• पुनर्विक्रेता। अपने क्लाइंट संगठनों में से किसी एक पर कार्रवाई करने के लिए org_id पास करें। जब आपकी कुंजी या कनेक्शन ठीक एक संगठन तक पहुँचता है, तो इसे छोड़ दें।

उदाहरण: API के साथ एक ड्राफ़्ट अभियान बनाएँ

curl -X POST https://api.zinndigital.com/v1/email-marketing/campaigns \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Spring sale",
  "subject": "Our spring sale starts today",
  "list_id": "<list id>",
  "sender_id": "<sender id>",
  "template": "basic"
}'

उत्तर ड्राफ्ट के साथ 201 है। इसका परीक्षण POST /v1/email-marketing/campaigns/{campaign_id}/test के साथ करें, GET /v1/email-marketing/campaigns/{campaign_id}/lint के साथ इसकी जाँच करें, और इसे POST /v1/email-marketing/campaigns/{campaign_id}/send के साथ भेजें।

उदाहरण: AI सहायक से वही ड्राफ्ट

अपने सहायक से सरल शब्दों में पूछें, उदाहरण के लिए "'हमारा वसंत सेल आज शुरू हो रहा है' विषय के साथ वसंत सेल नामक एक Zinn® Campaigns ईमेल ड्राफ्ट करें"। पृष्ठभूमि में, यह api_operations_search के साथ ऑपरेशन ढूँढता है, api_operation_get के साथ इसके पैरामीटर पढ़ता है, और इसे api_operation_call के साथ चलाता है:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "api_operation_call",
    "arguments": {
      "operation_id": "createEmailMarketingCampaign",
      "confirm": true,
      "body": {
        "name": "Spring sale",
        "subject": "Our spring sale starts today"
      }
    }
  }
}

सहायक क्या नहीं करेगा। ऐसा कुछ भी जो आपके प्राप्तकर्ताओं को भेजा जाता है या जिसमें पैसे या सीमा खर्च होती है — जैसे अभियान भेजना, SMS या WhatsApp संदेश भेजना, AI क्रेडिट के साथ लिखना, US टेक्स्टिंग के लिए पंजीकरण करना — सहायक के लिए अस्वीकृत कर दिया जाता है, ताकि गलत समझा गया निर्देश कभी भी आपके ग्राहकों तक न पहुँच सके। सहायक ड्राफ़्ट तैयार करता है; आप डैशबोर्ड में भेजें दबाते हैं या स्वयं API को कॉल करते हैं। SMTP पासवर्ड जैसे गोपनीय विवरण भी सहायक के माध्यम से कभी नहीं भेजे जाते: उन्हें डैशबोर्ड में दर्ज करें।

सीमाएँ

• प्रत्येक व्यक्ति या API कुंजी के लिए 1,200 अनुरोध प्रति मिनट, और प्रत्येक संगठन के लिए 6,000 अनुरोध प्रति मिनट। दोनों में से जो अधिक सख्त हो, वह लागू होती है।
• प्रत्येक MCP कनेक्शन के लिए 600 अनुरोध प्रति मिनट।
• सीमा से अधिक होने पर, उत्तर Retry-After हेडर के साथ 429 होता है: उतने सेकंड प्रतीक्षा करें।
• सूची के सदस्यों को जोड़ने के लिए प्रति अनुरोध अधिकतम 1,000 पते लिए जा सकते हैं; आपके प्लान की संपर्क और ईमेल सीमाएँ API के माध्यम से आपके द्वारा किए जाने वाले प्रत्येक कार्य पर लागू होती हैं।

त्रुटियाँ

प्रत्येक त्रुटि का प्रारूप एक समान होता है:

{"error": {"code": "UNPROCESSABLE_ENTITY", "message": "…", "details": [{"field": "subject", "code": "REQUIRED", "message": "…"}], "request_id": "…"}}

code समान समस्या के लिए कभी नहीं बदलता है, इसलिए message के बजाय इसका परीक्षण करें। जब आप सहायता टीम से संपर्क करें, तो request_id का उल्लेख करें। आपको मिलने वाले उत्तर: 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 CONFLICT, 422 UNPROCESSABLE_ENTITY, 429 TOO_MANY_REQUESTS। 403 का अर्थ है कि कुंजी या कनेक्शन में नीचे दी गई सूची में नामित अनुमति का अभाव है; 404 उस संगठन की किसी ऐसी चीज़ को भी कवर करता है जिसे आप नहीं देख सकते; 422 details में प्रत्येक गलत फ़ील्ड को सूचीबद्ध करता है; 429 के बाद, Retry-After हेडर में दिए गए सेकंडों की संख्या तक प्रतीक्षा करें।

Webhooks

डिलीवरी परिणाम आपका ईमेल भेजने वाले प्रदाता से Zinn® Campaigns में आते हैं:

• अपने स्वयं के प्रदाता (उदाहरण के लिए Resend) के साथ, डैशबोर्ड (Campaigns → Sending) में भेजने वाले कनेक्शन पर इसका वेबहुक साइनिंग सीक्रेट संग्रहीत करें। आपको एक webhook_url प्राप्त होता है; प्रदाता के delivered, bounced और complained इवेंट्स को इस पर इंगित करें। बाउंस या स्पैम शिकायत उस पते को भविष्य के प्रेषणों से तुरंत हटा देती है।
• Zinn® भेजने की सुविधा के साथ, सेट अप करने के लिए कुछ भी नहीं है।

रिपोर्ट संचालन (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport) के साथ परिणाम पढ़ें।

प्रत्येक Campaigns संचालन

अवलोकन

• GET /v1/email-marketing — एक संगठन के लिए Zinn® Campaigns का अवलोकन। संचालन getEmailMarketingOverview। जाँची गई अनुमतियाँ: email_marketing.view। एआई सहायक से: हाँ, MCP के माध्यम से।

ईमेल अभियान

• GET /v1/email-marketing/campaigns — ईमेल अभियान, सबसे नए पहले, एक कीसेट (keyset) पृष्ठ। ऑपरेशन listEmailMarketingCampaigns। जाँची गई अनुमतियाँ: email_marketing.view। एआई सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/email-marketing/campaigns — एक ड्राफ़्ट ईमेल अभियान बनाएँ। ऑपरेशन createEmailMarketingCampaign। जाँची गई अनुमतियाँ: email_marketing.manage, email_marketing.view। एआई सहायक से: हाँ, MCP के माध्यम से।
• GET /v1/email-marketing/campaigns/{campaign_id} — एक ईमेल अभियान। ऑपरेशन getEmailMarketingCampaign। जाँची गई अनुमतियाँ: email_marketing.view। एआई सहायक से: हाँ, MCP के माध्यम से।
• PATCH /v1/email-marketing/campaigns/{campaign_id} — ड्राफ़्ट संपादित करें (या अस्वीकृत अभियान, जो ड्राफ़्ट पर वापस आ जाता है)। ऑपरेशन updateEmailMarketingCampaign। जाँची गई अनुमतियाँ: email_marketing.manage, email_marketing.view। एआई सहायक से: हाँ, MCP के माध्यम से।
• GET /v1/email-marketing/campaigns/{campaign_id}/lint — भेजे जाने से पहले अभियान की सामग्री में वितरण संबंधी समस्याओं की जाँच करें। ऑपरेशन lintEmailMarketingCampaign। जाँची गई अनुमतियाँ: email_marketing.view। एआई सहायक से: हाँ, MCP के माध्यम से।
• GET /v1/email-marketing/campaigns/{campaign_id}/report — किसी अभियान के आँकड़े। ऑपरेशन getEmailMarketingCampaignReport। जाँची गई अनुमतियाँ: email_marketing.view। एआई सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/email-marketing/campaigns/{campaign_id}/send — किसी अभियान को उसकी सूची में भेजना शुरू करें। कार्रवाई sendEmailMarketingCampaign। जाँचे गए अनुमतियाँ: email_marketing.manage, email_marketing.view। AI सहायक से: केवल API और डैशबोर्ड: यह पैसे या भत्ते का उपयोग करता है, इसलिए कोई व्यक्ति इसे दबाता है (वास्तविक प्राप्तकर्ताओं को भेजता है और भत्ते का उपयोग करता है)।
• POST /v1/email-marketing/campaigns/{campaign_id}/test — संगठन के किसी सदस्य को अभी एक परीक्षण प्रति भेजें। कार्रवाई testEmailMarketingCampaign। जाँचे गए अनुमतियाँ: email_marketing.manage, email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/email-marketing/campaigns/{campaign_id}/translate — किसी अभियान को प्रत्येक ऐसी संपर्क भाषा में अनुवादित करें जो अनुपलब्ध या पुरानी है। कार्रवाई translateEmailMarketingCampaign। जाँचे गए अनुमतियाँ: email_marketing.manage, email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• GET /v1/email-marketing/campaigns/{campaign_id}/translations — किसी अभियान की सूची की प्रत्येक संपर्क भाषा और यह कि क्या उसका अनुवाद अद्यतित है। कार्रवाई listEmailMarketingCampaignTranslations। जाँचे गए अनुमतियाँ: email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।

AI के साथ लेखन

• POST /v1/email-marketing/ai/write — Zinn® AI के साथ एक संक्षिप्त विवरण से एक ड्राफ्ट अभियान ईमेल लिखें। ऑपरेशन writeEmailMarketingCampaignWithAi। अनुमतियों की जाँच की गई: email_marketing.manage, email_marketing.view। AI सहायक से: केवल API और डैशबोर्ड: इसमें पैसे या भत्ते खर्च होते हैं, इसलिए कोई व्यक्ति इसे दबाता है (AI लेखन में AI क्रेडिट खर्च होते हैं)।

ब्रांड किट

• GET /v1/email-marketing/brand-kit — संगठन का ब्रांड किट (नाम, लोगो, रंग, फ़ॉन्ट, आवाज़)। ऑपरेशन getEmailMarketingBrandKit। अनुमतियों की जाँच की गई: email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• PUT /v1/email-marketing/brand-kit — ब्रांड किट संपादित करें। ऑपरेशन updateEmailMarketingBrandKit। अनुमतियों की जाँच की गई: email_marketing.manage, email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/email-marketing/brand-kit/read — संगठन की वेबसाइट से ब्रांड किट पढ़ें। ऑपरेशन readEmailMarketingBrandKit। अनुमतियों की जाँच की गई: email_marketing.manage, email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।

संपर्क और एकल संदेश

• GET /v1/email-marketing/contacts — संगठन के संपर्क, एक बार में एक कीसेट (keyset) पृष्ठ। ऑपरेशन listEmailMarketingContacts। अनुमतियों की जाँच की गई: email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/email-marketing/contacts/{contact_id}/messages — एक संपर्क को एक SMS भेजें, जिसका भुगतान Zinn® क्रेडिट बैलेंस से किया जाता है। ऑपरेशन sendEmailMarketingMessage। अनुमतियों की जाँच की गई: email_marketing.manage, email_marketing.view। AI सहायक से: केवल API और डैशबोर्ड: इसमें पैसे या अलाउंस खर्च होते हैं, इसलिए इसे कोई व्यक्ति दबाता है (किसी संपर्क को भेजा गया एकल संदेश अलाउंस खर्च करता है)।
• GET /v1/email-marketing/messages — संगठन द्वारा भेजे गए SMS और WhatsApp संदेश, सबसे नए पहले, एक कीसेट (keyset) पृष्ठ। ऑपरेशन listEmailMarketingMessages। अनुमतियों की जाँच की गई: email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।

सूचियाँ

• GET /v1/email-marketing/lists — संगठन की मेलिंग सूचियां, जिनमें सब्सक्राइब की गई / अनसब्सक्राइब की गई संख्या शामिल है। ऑपरेशन listEmailMarketingLists। जांची गई अनुमतियां: email_marketing.view। AI सहायक से: हां, MCP के माध्यम से।
• POST /v1/email-marketing/lists — एक मेलिंग सूची बनाएं (या उस नाम वाली सूची वापस पाएं)। ऑपरेशन createEmailMarketingList। जांची गई अनुमतियां: email_marketing.manage, email_marketing.view। AI सहायक से: हां, MCP के माध्यम से।
• POST /v1/email-marketing/lists/{list_id}/members — ईमेल पते द्वारा सूची में संपर्क जोड़ें (प्रति अनुरोध अधिकतम 1,000)। ऑपरेशन addEmailMarketingListMembers। जांची गई अनुमतियां: email_marketing.manage, email_marketing.view। AI सहायक से: हां, MCP के माध्यम से।

आयात

• GET /v1/email-marketing/imports — पिछले संपर्क आयात, सबसे नए पहले, एक बार में एक कीसेट पृष्ठ। ऑपरेशन listEmailMarketingImports। जांची गई अनुमतियां: email_marketing.view। AI सहायक से: हां, MCP के माध्यम से।
• POST /v1/email-marketing/imports — सहमति प्रमाणन के साथ संपर्कों का एक खंड आयात करें। ऑपरेशन createEmailMarketingImport। जांची गई अनुमतियां: email_marketing.manage, email_marketing.view। AI सहायक से: हां, MCP के माध्यम से।

साइन-अप फ़ॉर्म

• GET /v1/email-marketing/forms — साइन-अप फ़ॉर्म (डबल ऑप्ट-इन), सबसे नए पहले, एक कीसेट पृष्ठ। ऑपरेशन listEmailMarketingForms। जाँची गई अनुमतियाँ: email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/email-marketing/forms — एक साइन-अप फ़ॉर्म बनाएँ जो पुष्टि किए गए लोगों को एक सूची में जोड़ता है। ऑपरेशन createEmailMarketingForm। जाँची गई अनुमतियाँ: email_marketing.manage, email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• DELETE /v1/email-marketing/forms/{form_id} — एक साइन-अप फ़ॉर्म हटाएँ (पहले से पुष्टि किए गए लोग सूची में बने रहते हैं)। ऑपरेशन deleteEmailMarketingForm। जाँची गई अनुमतियाँ: email_marketing.manage, email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• PATCH /v1/email-marketing/forms/{form_id} — एक साइन-अप फ़ॉर्म बदलें (शब्दावली, सूची, रीडायरेक्ट, चालू या बंद)। ऑपरेशन updateEmailMarketingForm। जाँची गई अनुमतियाँ: email_marketing.manage, email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।

भेजने के कनेक्शन

• GET /v1/email-marketing/senders — संगठन के भेजने वाले कनेक्शन। ऑपरेशन listEmailMarketingSenders। जाँचे गए अनुमतियाँ: email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/email-marketing/senders — एक अभियान प्रेषक कनेक्ट करें (Zinn® भेजना, या ग्राहक का अपना SMTP सर्वर)। ऑपरेशन createEmailMarketingSender। जाँचे गए अनुमतियाँ: email_marketing.manage, email_marketing.view। AI सहायक से: केवल API और डैशबोर्ड: इसमें एक गुप्त विवरण होता है जो कभी भी AI मॉडल तक नहीं पहुँचना चाहिए (बॉडी SMTP पासवर्ड है)।
• DELETE /v1/email-marketing/senders/{sender_id} — भेजने वाले कनेक्शन और उसके संग्रहीत पासवर्ड को हटाएँ। ऑपरेशन deleteEmailMarketingSender। जाँचे गए अनुमतियाँ: email_marketing.manage, email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/email-marketing/senders/{sender_id}/verify — कुछ भी भेजे बिना यह सत्यापित करें कि भेजने वाला कनेक्शन काम कर रहा है। ऑपरेशन verifyEmailMarketingSender। जाँचे गए अनुमतियाँ: email_marketing.manage, email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• PUT /v1/email-marketing/senders/{sender_id}/webhook — इस कनेक्शन के लिए अपने ईमेल प्रदाता का वेबहुक साइनिंग सीक्रेट संग्रहीत करें। ऑपरेशन setEmailMarketingSenderWebhook। जाँचे गए अनुमतियाँ: email_marketing.manage, email_marketing.view। AI सहायक से: किसी अन्य सिस्टम द्वारा कॉल किया जाता है (प्रदाता या आगंतुक), आपके द्वारा नहीं (प्रदाता का वेबहुक सीक्रेट संग्रहीत करता है)।

SMS और WhatsApp

• GET /v1/email-marketing/sms — SMS स्क्रीन के लिए आवश्यक विवरण — खुला है?, रुका हुआ है?, क्रेडिट बैलेंस और कीमतें। ऑपरेशन getEmailMarketingSms। जाँची गई अनुमतियाँ: email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• GET /v1/email-marketing/sms/campaigns — बल्क SMS अभियान, नवीनतम पहले, एक कीसेट पृष्ठ। ऑपरेशन listSmsMarketingCampaigns। जाँची गई अनुमतियाँ: email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/email-marketing/sms/campaigns — किसी सूची के लिए एक ड्राफ्ट SMS बनाएँ। ऑपरेशन createSmsMarketingCampaign। जाँची गई अनुमतियाँ: email_marketing.manage, email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• GET /v1/email-marketing/sms/campaigns/{campaign_id} — एक बल्क SMS अभियान। ऑपरेशन getSmsMarketingCampaign। जाँची गई अनुमतियाँ: email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — ड्राफ्ट संपादित करें (या अस्वीकृत अभियान, जो ड्राफ्ट में वापस आ जाता है)। ऑपरेशन updateSmsMarketingCampaign। जाँची गई अनुमतियाँ: email_marketing.manage, email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — किसी बल्क SMS अभियान के आँकड़े। ऑपरेशन getSmsMarketingCampaignReport। जाँची गई अनुमतियाँ: email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — इसकी सूची में मौजूद उन सभी लोगों को SMS भेजना शुरू करें जो SMS के लिए सहमत हुए हैं — या क्रेडिट के कारण रोके गए अभियान को फिर से शुरू करें। ऑपरेशन sendSmsMarketingCampaign। जाँचे गए अनुमतियाँ: email_marketing.manage, email_marketing.view। AI सहायक से: केवल API और डैशबोर्ड: यह पैसे या भत्ते खर्च करता है, इसलिए कोई व्यक्ति इसे दबाता है (सशुल्क SMS/WhatsApp संदेश भेजता है)।
• GET /v1/email-marketing/sms/registrations/us — इस संगठन का US 10DLC पंजीकरण, और इसकी लागत। ऑपरेशन getEmailMarketingUsRegistration। जाँचे गए अनुमतियाँ: email_marketing.view। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/email-marketing/sms/registrations/us — US 10DLC के लिए इस संगठन का ब्रांड और अभियान सबमिट करें (सबमिट करने पर शुल्क लिया जाता है)। ऑपरेशन submitEmailMarketingUsRegistration। जाँचे गए अनुमतियाँ: email_marketing.manage, email_marketing.view। AI सहायक से: केवल API और डैशबोर्ड: यह पैसे या भत्ते खर्च करता है, इसलिए कोई व्यक्ति इसे दबाता है (US 10DLC पंजीकरण पर कैरियर शुल्क लागू होते हैं)।

आपकी अपनी ईमेल सेवा के माध्यम से अभियान (टेम्प्लेट, सेगमेंट, सप्रेशन)

• GET /v1/campaigns — संगठन के अभियान। ऑपरेशन listCampaigns। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/campaigns — किसी टेम्प्लेट और ऑडियंस से एक अभियान बनाएँ। ऑपरेशन createCampaign। AI सहायक से: हाँ, MCP के माध्यम से।
• DELETE /v1/campaigns/esp — प्रदाता खाते को डिस्कनेक्ट करें और इसकी संग्रहीत कुंजी हटाएं। ऑपरेशन disconnectEsp। AI सहायक से: केवल API और डैशबोर्ड: इसमें एक ऐसा सीक्रेट शामिल है जिसे कभी भी AI मॉडल तक नहीं पहुंचना चाहिए (संग्रहीत ESP कुंजी को नष्ट करता है)।
• GET /v1/campaigns/esp — संगठन का अपना ई-मेल प्रदाता खाता। ऑपरेशन getEspConnection। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/campaigns/esp — एक ई-मेल प्रदाता खाता कनेक्ट करें। ऑपरेशन connectEsp। AI सहायक से: केवल API और डैशबोर्ड: इसमें एक ऐसा सीक्रेट शामिल है जिसे कभी भी AI मॉडल तक नहीं पहुंचना चाहिए (बॉडी ही ESP API कुंजी है)।
• POST /v1/campaigns/esp/verify — साबित करें कि प्रदाता खाता काम कर रहा है और इसके सत्यापित डोमेन पढ़ें। ऑपरेशन verifyEspConnection। AI सहायक से: केवल API और डैशबोर्ड: इसमें एक ऐसा सीक्रेट शामिल है जिसे कभी भी AI मॉडल तक नहीं पहुंचना चाहिए (संग्रहीत ESP कुंजी की पुन: जाँच करता है)।
• POST /v1/campaigns/preview — उदाहरण मानों के साथ टेम्पलेट को Render करें। ऑपरेशन previewCampaignTemplate। AI सहायक से: हाँ, MCP के माध्यम से।
• GET /v1/campaigns/segments — आपके सहेजे गए ऑडियंस सेगमेंट। ऑपरेशन listCampaignSegments। अनुमतियों की जाँच की गई: campaigns.view। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/campaigns/segments — एक नया ऑडियंस सेगमेंट सहेजें। ऑपरेशन createCampaignSegment। अनुमतियों की जाँच की गई: campaigns.manage। AI सहायक से: हाँ, MCP के माध्यम से।
• GET /v1/campaigns/segments/fields — फ़िल्टर शब्दावली, इसकी मान सूचियाँ और मैजिक टैग। ऑपरेशन getCampaignSegmentFields। जाँची गई अनुमतियाँ: campaigns.view। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/campaigns/segments/preview — यह कितने लोगों तक पहुँचता है, वे कौन हैं, और यह किन्हें छोड़ देता है। ऑपरेशन previewCampaignSegment। जाँची गई अनुमतियाँ: campaigns.view। AI सहायक से: हाँ, MCP के माध्यम से।
• DELETE /v1/campaigns/segments/{segmentId} — किसी सेगमेंट को संग्रहीत करें। ऑपरेशन archiveCampaignSegment। जाँची गई अनुमतियाँ: campaigns.manage। AI सहायक से: हाँ, MCP के माध्यम से।
• GET /v1/campaigns/segments/{segmentId} — एक सहेजा गया सेगमेंट। ऑपरेशन getCampaignSegment। जाँची गई अनुमतियाँ: campaigns.view। AI सहायक से: हाँ, MCP के माध्यम से।
• PATCH /v1/campaigns/segments/{segmentId} — किसी सेगमेंट का नाम बदलें या उसके फ़िल्टर संशोधित करें। ऑपरेशन updateCampaignSegment। जाँची गई अनुमतियाँ: campaigns.manage। AI सहायक से: हाँ, MCP के माध्यम से।
• GET /v1/campaigns/suppressions — वे पते जिन्हें मार्केटिंग सामग्री प्राप्त नहीं होनी चाहिए। ऑपरेशन listCampaignSuppressions। जाँची गई अनुमतियाँ: campaigns.view। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/campaigns/suppressions — सप्रेशन सूची में कोई पता जोड़ें। ऑपरेशन createCampaignSuppression। जाँची गई अनुमतियाँ: campaigns.manage। AI सहायक से: हाँ, MCP के माध्यम से।
• GET /v1/campaigns/tags — मैजिक-टैग पैलेट जो एक अभियान कंपोज़र प्रदान करता है। ऑपरेशन listCampaignTags। AI सहायक से: हाँ, MCP के माध्यम से।
• GET /v1/campaigns/templates — संगठन के अभियान टेम्पलेट। ऑपरेशन listCampaignTemplates। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/campaigns/templates — एक अभियान टेम्पलेट बनाएँ। ऑपरेशन createCampaignTemplate। AI सहायक से: हाँ, MCP के माध्यम से।
• DELETE /v1/campaigns/templates/{templateId} — टेम्पलेट को संग्रहीत करें और उसके अनुवाद स्रोतों को अप्रचलित करें। ऑपरेशन archiveCampaignTemplate। AI सहायक से: हाँ, MCP के माध्यम से।
• GET /v1/campaigns/templates/{templateId} — एक अभियान टेम्पलेट। ऑपरेशन getCampaignTemplate। AI सहायक से: हाँ, MCP के माध्यम से।
• PUT /v1/campaigns/templates/{templateId} — अभियान टेम्पलेट संपादित करें। ऑपरेशन updateCampaignTemplate। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/campaigns/unsubscribe — मार्केटिंग सूची छोड़ें। किसी खाते की आवश्यकता नहीं है। ऑपरेशन unsubscribeFromCampaigns। AI सहायक से: केवल API और डैशबोर्ड: इसमें एक ऐसा सीक्रेट शामिल है जो कभी भी किसी AI मॉडल तक नहीं पहुँचना चाहिए (प्राप्तकर्ता का हस्ताक्षरित अनसब्सक्राइब टोकन लेता है)।
• DELETE /v1/campaigns/{campaignId} — एक अभियान हटाएँ और उसकी डिलीवरी पंक्तियों को अप्रचलित करें। ऑपरेशन deleteCampaign। AI सहायक से: केवल API और डैशबोर्ड: इसके लिए ऐसी अनुमति की आवश्यकता होती है जो AI कनेक्शन को प्रदान नहीं की जाती है (ESP अभियान को हटाने के लिए campaigns.send की आवश्यकता होती है)।
• GET /v1/campaigns/{campaignId} — एक अभियान और उसकी डिलीवरी रिपोर्ट। ऑपरेशन getCampaign। AI सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/campaigns/{campaignId}/control — चल रहे प्रेषण को रोकें, फिर से शुरू करें या रद्द करें। ऑपरेशन controlCampaign। AI सहायक से: केवल API और डैशबोर्ड: यह पैसे या भत्ते का उपयोग करता है, इसलिए कोई व्यक्ति इसे दबाता है (लाइव प्रेषण को रोकता/फिर से शुरू करता है)।
• POST /v1/campaigns/{campaignId}/send — स्थायी प्रेषण प्रारंभ करें। ऑपरेशन sendCampaign। AI सहायक से: केवल API और डैशबोर्ड: यह पैसे या भत्ते का उपयोग करता है, इसलिए कोई व्यक्ति इसे दबाता है (वास्तविक प्राप्तकर्ताओं को ESP अभियान भेजता है)।
• POST /v1/campaigns/{campaignId}/test — अभियान द्वारा वास्तव में उपयोग किए जाने वाले चैनल पर एक वास्तविक संदेश भेजें। ऑपरेशन testSendCampaign। AI सहायक से: केवल API और डैशबोर्ड: इसके लिए एक ऐसी अनुमति की आवश्यकता होती है जो AI कनेक्शनों को प्रदान नहीं की जाती है (एक ESP परीक्षण प्रेषण के लिए campaigns.send की आवश्यकता होती है)।

सार्वजनिक पृष्ठ और आने वाले वेबहुक

• GET /v1/public/email-marketing/c/{token} — क्लिक काउंटर। प्रति प्राप्तकर्ता एक क्लिक रिकॉर्ड करता है और मूल लिंक पर रीडायरेक्ट करता है। ऑपरेशन emailMarketingClick। AI सहायक से: एक पृष्ठ जिसे आपके प्राप्तकर्ता ईमेल से खोलते हैं (क्लिक-ट्रैकिंग रीडायरेक्ट)।
• GET /v1/public/email-marketing/f/{public_id} — साइन-अप फ़ॉर्म का होस्ट किया गया पृष्ठ (लॉगिन की आवश्यकता नहीं)। ऑपरेशन emailMarketingFormPage। AI सहायक से: एक पृष्ठ जिसे आपके प्राप्तकर्ता ईमेल से खोलते हैं (सार्वजनिक साइनअप फ़ॉर्म पृष्ठ)।
• POST /v1/public/email-marketing/f/{public_id} — साइन-अप फ़ॉर्म सबमिट करें (होस्ट किया गया पेज, एम्बेड या JSON)। ऑपरेशन emailMarketingFormSubmit। AI सहायक की ओर से: किसी अन्य सिस्टम (प्रदाता या विज़िटर) द्वारा कॉल किया जाता है, आपके द्वारा नहीं (एक विज़िटर साइनअप फ़ॉर्म सबमिट करता है)।
• GET /v1/public/email-marketing/fc — डबल ऑप्ट-इन पुष्टिकरण पेज (लॉगिन की आवश्यकता नहीं)। ऑपरेशन emailMarketingFormConfirmPage। AI सहायक की ओर से: एक पेज जिसे आपके प्राप्तकर्ता ईमेल से खोलते हैं (डबल ऑप्ट-इन पुष्टिकरण पेज)।
• POST /v1/public/email-marketing/fc — साइन-अप की पुष्टि करें (सहमति रिकॉर्ड के साथ व्यक्ति को सूची में जोड़ता है)। ऑपरेशन emailMarketingFormConfirm। AI सहायक की ओर से: किसी अन्य सिस्टम (प्रदाता या विज़िटर) द्वारा कॉल किया जाता है, आपके द्वारा नहीं (एक विज़िटर डबल ऑप्ट-इन की पुष्टि करता है)।
• GET /v1/public/email-marketing/o/{token} — ओपन-ट्रैकिंग इमेज (1x1 GIF)। प्रति प्राप्तकर्ता एक बार खोले जाने की गणना करता है। ऑपरेशन emailMarketingOpenPixel। AI सहायक की ओर से: एक पेज जिसे आपके प्राप्तकर्ता ईमेल से खोलते हैं (ओपन-ट्रैकिंग पिक्सेल)।
• GET /v1/public/email-marketing/u/{token} — फ़ुटर अनसब्सक्राइब लिंक (लॉगिन की आवश्यकता नहीं)। ऑपरेशन emailMarketingUnsubscribePage। AI सहायक की ओर से: एक पेज जिसे आपके प्राप्तकर्ता ईमेल से खोलते हैं (सदस्यता समाप्त करने का पेज)।
• POST /v1/public/email-marketing/u/{token} — RFC 8058 वन-क्लिक अनसब्सक्राइब (और पृष्ठ का "सब कुछ रोकें" बटन)। ऑपरेशन emailMarketingUnsubscribeOneClick। AI सहायक की ओर से: किसी अन्य सिस्टम (प्रदाता या आगंतुक) द्वारा कॉल किया जाता है, आपके द्वारा नहीं (RFC 8058 वन-क्लिक अनसब्सक्राइब)।
• GET /v1/public/email-marketing/warmup-u/{token} — मार्केटिंग पूल वॉर्म-अप ईमेल का अनसब्सक्राइब लिंक (कोई लॉगिन नहीं)। ऑपरेशन emailMarketingWarmupUnsubscribePage। AI सहायक की ओर से: एक पृष्ठ जिसे आपके प्राप्तकर्ता ईमेल से खोलते हैं (वॉर्म-अप अनसब्सक्राइब पृष्ठ)।
• POST /v1/public/email-marketing/warmup-u/{token} — वॉर्म-अप ईमेल से RFC 8058 वन-क्लिक अनसब्सक्राइब। ऑपरेशन emailMarketingWarmupUnsubscribeOneClick। AI सहायक की ओर से: किसी अन्य सिस्टम (प्रदाता या आगंतुक) द्वारा कॉल किया जाता है, आपके द्वारा नहीं (वॉर्म-अप वन-क्लिक अनसब्सक्राइब)।
• POST /v1/webhooks/campaign-events — ईमेल प्रदाता से हस्ताक्षरित डिलीवरी इवेंट प्राप्त करें। ऑपरेशन receiveCampaignDeliveryWebhook। AI सहायक की ओर से: किसी अन्य सिस्टम (प्रदाता या आगंतुक) द्वारा कॉल किया जाता है, आपके द्वारा नहीं (हस्ताक्षरित ESP डिलीवरी वेबहुक)।
• POST /v1/webhooks/campaigns/telnyx — हमारे SMS विक्रेता से आने वाले SMS उत्तर (STOP / START)। ऑपरेशन receiveCampaignsTelnyxInbound। AI सहायक की ओर से: किसी अन्य सिस्टम (प्रदाता या आगंतुक) द्वारा कॉल किया जाता है, आपके द्वारा नहीं (हस्ताक्षरित Telnyx इनबाउंड वेबहुक)।
• POST /v1/webhooks/email-marketing/{connection_id} — एक सेंडिंग कनेक्शन के लिए ग्राहक के अपने ईमेल प्रदाता के डिलीवरी इवेंट। ऑपरेशन receiveEmailMarketingProviderWebhook। AI सहायक की ओर से: किसी अन्य सिस्टम (प्रदाता या विज़िटर) द्वारा कॉल किया जाता है, आपके द्वारा नहीं (हस्ताक्षरित सेंडर-प्रोवाइडर वेबहुक)।

Flows

• GET /v1/email-marketing/flows — ईमेल फ़्लो (स्वागत, ड्रिप, एक वार्षिक तिथि), एक कीसेट पेज। ऑपरेशन listEmailMarketingFlows। जांची गई अनुमतियाँ: email_marketing.view। AI सहायक की ओर से: हाँ, MCP के माध्यम से।
• POST /v1/email-marketing/flows — एक फ़्लो बनाएँ (यह ड्राफ़्ट के रूप में शुरू होता है)। ऑपरेशन createEmailMarketingFlow। जांची गई अनुमतियाँ: email_marketing.manage, email_marketing.view। AI सहायक की ओर से: हाँ, MCP के माध्यम से।
• DELETE /v1/email-marketing/flows/{flow_id} — फ़्लो और उसके एनरोलमेंट हटाएँ (इसके भेजे गए रन कैंपेन के रूप में बने रहते हैं)। ऑपरेशन deleteEmailMarketingFlow। जांची गई अनुमतियाँ: email_marketing.manage, email_marketing.view। AI सहायक की ओर से: हाँ, MCP के माध्यम से।
• GET /v1/email-marketing/flows/{flow_id} — चरणों और रिपोर्ट के साथ एक फ़्लो (एनरोल किए गए, प्रगति पर, प्रति चरण रन और प्राप्तकर्ता)। ऑपरेशन getEmailMarketingFlow। जांची गई अनुमतियाँ: email_marketing.view। AI सहायक की ओर से: हाँ, MCP के माध्यम से।
• PATCH /v1/email-marketing/flows/{flow_id} — किसी प्रवाह (flow) को बदलें; steps, दिए जाने पर, पूरे अनुक्रम को प्रतिस्थापित करता है। ऑपरेशन updateEmailMarketingFlow। जाँची गई अनुमतियाँ: email_marketing.manage, email_marketing.view। एआई सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/email-marketing/flows/{flow_id}/activate — किसी प्रवाह को चालू करें; अब से केवल सूची में शामिल होने वाले लोगों को ही नामांकित किया जाएगा। ऑपरेशन activateEmailMarketingFlow। जाँची गई अनुमतियाँ: email_marketing.manage, email_marketing.view। एआई सहायक से: हाँ, MCP के माध्यम से।
• POST /v1/email-marketing/flows/{flow_id}/pause — किसी प्रवाह को रोकें; देय चरण प्रतीक्षा करते हैं और इसे फिर से चालू किए जाने तक किसी नए व्यक्ति को ईमेल नहीं भेजा जाता है। ऑपरेशन pauseEmailMarketingFlow। जाँची गई अनुमतियाँ: email_marketing.manage, email_marketing.view। एआई सहायक से: हाँ, MCP के माध्यम से।