Zinn® Campaigns API आणि MCP: डेव्हलपर मार्गदर्शक

डॅशबोर्डवर तुम्ही Zinn® Campaigns मध्ये जे काही करू शकता, ते सर्व तुम्ही API द्वारे देखील करू शकता आणि त्यातील बहुतांश गोष्टी MCP द्वारे तुमच्या खात्याशी जोडलेल्या AI असिस्टंटवरून करू शकता. हे मार्गदर्शक साइन इन करणे, परवानग्या, दोन्ही पद्धतींचे एक सोडवलेले उदाहरण, मर्यादा, त्रुटी आणि Campaigns च्या सर्व ८९ ऑपरेशन्सचा समावेश करते. खालील ऑपरेशन्सची सूची आमच्या API स्पेसिफिकेशनवरून तयार केली गेली आहे, त्यामुळे ती API जे करते त्याच्याशी नेहमी जुळते. प्रत्येक ऑपरेशनचे प्रत्येक फील्ड zinndigital.com/developers/api/zinn-campaigns येथील API संदर्भात उपलब्ध आहे.

साइन इन करत आहे

• API की. सेटिंग्ज → API की अंतर्गत डॅशबोर्डमध्ये एक की तयार करा आणि ती Authorization: Bearer zdk_live_… म्हणून पाठवा (सँडबॉक्स मोडमध्ये zdk_test_… की कार्य करते). की ला फक्त आवश्यक असलेल्या मोहिमांच्या परवानग्या द्या आणि त्यापेक्षा जास्त काहीही नाही.
• AI सहाय्यक (MCP). अ‍ॅपमधून साइन इन करून किंवा कनेक्शन टोकन (zmcp_live_…) द्वारे Claude, ChatGPT, Cursor किंवा कोणताही MCP क्लायंट https://api.zinndigital.com/v1/mcp शी कनेक्ट करा. तुमच्या खात्याशी 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 सहाय्यकाकडून तोच मसुदा

आपल्या सहाय्यकाला सोप्या शब्दांत विचारा, उदाहरणार्थ "'Our spring sale starts today' या विषयावर Spring sale नावाचा 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 मजकूर पाठवण्यासाठी नोंदणी करणे — हे सहाय्यकास नाकारले जाते, जेणेकरून गैरसमज झालेली सूचना आपल्या ग्राहकांपर्यंत कधीही पोहोचू शकत नाही. सहाय्यक मसुदा तयार करतो; आपण डॅशबोर्डमध्ये Send दाबा किंवा स्वतः API कॉल करा. SMTP पासवर्डसारखी गुपिते देखील कधीही सहाय्यकामार्फत पाठवली जात नाहीत: ती डॅशबोर्डमध्ये प्रविष्ट करा.

मर्यादा

• प्रत्येक व्यक्ती किंवा API कीसाठी प्रति मिनिट 1,200 विनंत्या, आणि प्रत्येक संस्थेसाठी प्रति मिनिट 6,000 विनंत्या. दोन्हीपैकी अधिक कठोर मर्यादा लागू होते.
• प्रत्येक MCP कनेक्शनसाठी प्रति मिनिट 600 विनंत्या.
• मर्यादेपेक्षा जास्त झाल्यास, उत्तर 429 सह Retry-After हेडर असे असेल: तेवढे सेकंद प्रतीक्षा करा.
• सूचीतील सदस्य जोडण्यासाठी प्रति विनंती जास्तीत जास्त 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), डॅशबोर्डमध्ये (मोहिमा → पाठवणे) पाठवण्याच्या कनेक्शनवर त्याचे वेबहूक स्वाक्षरीचे रहस्य साठवा. आपल्याला webhook_url मिळते; प्रदात्याचे वितरित (delivered), बाऊन्स झालेले (bounced) आणि तक्रार नोंदवलेले (complained) इव्हेंट त्यावर निर्देशित करा. बाऊन्स किंवा स्पॅम तक्रार तो पत्ता पुढील पाठवणींमधून त्वरित काढून टाकते.
• Zinn® पाठवणीसह, सेट अप करण्यासाठी काहीही नाही.

परिणाम अहवाल ऑपरेशन्सद्वारे वाचा (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).

प्रत्येक Campaigns ऑपरेशन

विहंगावलोकन

• GET /v1/email-marketing — एका संस्थेसाठी Zinn® Campaigns विहंगावलोकन. ऑपरेशन getEmailMarketingOverview. तपासलेल्या परवानग्या: email_marketing.view. AI सहाय्यकाकडून: होय, MCP द्वारे.

ईमेल मोहिमा

• GET /v1/email-marketing/campaigns — ईमेल मोहिमा, सर्वात नवीन आधी, एक कीसेट पृष्ठ. ऑपरेशन 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 — संस्थेचे संपर्क, एका वेळी एक कीसेट पृष्ठ. ऑपरेशन 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 संदेश, सर्वात नवीन प्रथम, एक कीसेट पृष्ठ. ऑपरेशन 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 द्वारे.

Imports

• GET /v1/email-marketing/imports — मागील संपर्क आयात, सर्वात नवीन प्रथम, एका वेळी एक keyset पृष्ठ. ऑपरेशन listEmailMarketingImports. तपासलेल्या परवानग्या: email_marketing.view. AI सहाय्यकाकडून: होय, MCP द्वारे.
• POST /v1/email-marketing/imports — संमती प्रमाणपत्रासह संपर्कांचा एक भाग आयात करा. ऑपरेशन createEmailMarketingImport. तपासलेल्या परवानग्या: email_marketing.manage, email_marketing.view. AI सहाय्यकाकडून: होय, MCP द्वारे.

Sign-up forms

• 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 — एसएमएस स्वीकारलेल्या यादीतील प्रत्येकाला एसएमएस पाठवणे सुरू करा — किंवा क्रेडिटअभावी थांबवलेली मोहीम पुन्हा सुरू करा. ऑपरेशन sendSmsMarketingCampaign. तपासल्या गेलेल्या परवानग्या: email_marketing.manage, email_marketing.view. एआय सहाय्यकाकडून: फक्त API आणि डॅशबोर्ड: यासाठी पैसे किंवा अलाउन्स खर्च होतो, त्यामुळे व्यक्तीने स्वतः हे दाबावे (सशुल्क एसएमएस/व्हॉट्सॲप संदेश पाठवले जातात).
• GET /v1/email-marketing/sms/registrations/us — या संस्थेची US 10DLC नोंदणी आणि त्यासाठी येणारा खर्च. ऑपरेशन getEmailMarketingUsRegistration. तपासल्या गेलेल्या परवानग्या: email_marketing.view. एआय सहाय्यकाकडून: होय, MCP द्वारे.
• POST /v1/email-marketing/sms/registrations/us — या संस्थेचा ब्रँड आणि मोहीम US 10DLC साठी सबमिट करा (सबमिट करताना शुल्क आकारले जाईल). ऑपरेशन submitEmailMarketingUsRegistration. तपासल्या गेलेल्या परवानग्या: email_marketing.manage, email_marketing.view. एआय सहाय्यकाकडून: फक्त API आणि डॅशबोर्ड: यासाठी पैसे किंवा अलाउन्स खर्च होतो, त्यामुळे व्यक्तीने स्वतः हे दाबावे (US 10DLC नोंदणीसाठी वाहक शुल्क आकारले जाते).

तुमच्या स्वतःच्या ईमेल सेवेद्वारे मोहीम (टेम्पलेट्स, सेगमेंट, सप्रेशन)

• GET /v1/campaigns — संस्थेच्या मोहिमा. ऑपरेशन listCampaigns. एआय सहाय्यकाकडून: होय, MCP द्वारे.
• POST /v1/campaigns — टेम्पलेट आणि प्रेक्षक वर्गावरून मोहीम तयार करा. ऑपरेशन createCampaign. एआय सहाय्यकाकडून: होय, 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} — प्रवाह बदला; steps, दिल्यास, संपूर्ण क्रम बदलतो. ऑपरेशन updateEmailMarketingFlow. तपासलेल्या परवानग्या: email_marketing.manage, email_marketing.view. AI सहाय्यकाकडून: होय, MCP द्वारे.
• POST /v1/email-marketing/flows/{flow_id}/activate — प्रवाह सुरू करा; आतापासून सूचीमध्ये सामील होणारे लोकच नोंदवले जातात. ऑपरेशन activateEmailMarketingFlow. तपासलेल्या परवानग्या: email_marketing.manage, email_marketing.view. AI सहाय्यकाकडून: होय, MCP द्वारे.
• POST /v1/email-marketing/flows/{flow_id}/pause — प्रवाह थांबवा; देय पायऱ्या प्रतीक्षा करतात आणि ते पुन्हा सुरू होईपर्यंत कोणालाही नवीन मेल पाठवला जात नाही. ऑपरेशन pauseEmailMarketingFlow. तपासलेल्या परवानग्या: email_marketing.manage, email_marketing.view. AI सहाय्यकाकडून: होय, MCP द्वारे.