Zinn® Campaigns API na MCP: mwongozo wa msanidi programu

Kila kitu unachoweza kufanya katika Zinn® Campaigns kwenye dashibodi unaweza pia kukifanya kupitia API, na sehemu kubwa yake kutoka kwa msaidizi wa AI aliyeunganishwa kwenye akaunti yako kupitia MCP. Mwongozo huu unashughulikia kuingia, ruhusa, mfano uliotatuliwa kwa njia zote mbili, mipaka, hitilafu na kila mojawapo ya shughuli 89 za Campaigns. Orodha ya shughuli hapa chini inatolewa kutoka kwa maelezo maalum ya API yetu, kwa hivyo inalingana kila wakati na kile ambacho API hufanya. Kila uga wa kila shughuli uko kwenye rejeleo la API katika zinndigital.com/developers/api/zinn-campaigns.

Kuingia

• Vifunguo vya API. Unda kifunguo kwenye dashibodi chini ya Mipangilio → Vifunguo vya API na ukitume kama Authorization: Bearer zdk_live_… (kifunguo cha zdk_test_… hufanya kazi katika hali ya kisanduku cha majaribio). Kipe kifunguo ruhusa za Campaigns kinachohitaji pekee na si zaidi.
• Wasaidizi wa AI (MCP). Unganisha Claude, ChatGPT, Cursor au kiteja chochote cha MCP kwenye https://api.zinndigital.com/v1/mcp, iwe kwa kuingia kutoka kwenye programu au kwa tokeni ya muunganisho (zmcp_live_…). Tazama Kuunganisha Claude, Cursor au ChatGPT kwenye akaunti yako. Kwenye skrini ya idhini, weka alama ya kuteua kwenye ruhusa za Zinn® Campaigns.
• Ruhusa. email_marketing.view husoma kampeni, orodha, waasiliani, fomu, watumaji, mipangilio ya SMS na ripoti; email_marketing.manage huzitengeneza na kuzibadilisha. Kampeni unazotuma kupitia huduma yako mwenyewe ya barua pepe hutumia campaigns.view na campaigns.manage.
• Wauzaji tena. Pitisha org_id ili kutenda kwa niaba ya mojawapo ya mashirika ya mteja wako. Iache wakati kifunguo au muunganisho wako unafikia shirika moja tu kamili.

Mfano: unda rasimu ya kampeni ukitumia 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"
}'

Jibu ni 201 pamoja na rasimu hiyo. Ijaribu kwa POST /v1/email-marketing/campaigns/{campaign_id}/test, ikague kwa GET /v1/email-marketing/campaigns/{campaign_id}/lint, na uitume kwa POST /v1/email-marketing/campaigns/{campaign_id}/send.

Mfano: rasimu hiyo hiyo kutoka kwa msaidizi wa AI

Muulize msaidizi wako kwa maneno ya kawaida, kwa mfano "andaa barua pepe ya Zinn® Campaigns inayoitwa Spring sale ikiwa na mada 'Our spring sale starts today'". Nyuma ya pazia hupata operesheni hiyo kwa api_operations_search, husoma vigezo vyake kwa api_operation_get, na kuiendesha kwa 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"
      }
    }
  }
}

Kile ambacho msaidizi hatafanya. Chochote kinachotuma kwa wapokeaji wako au kinachotumia pesa au posho — kutuma kampeni, kutuma ujumbe wa SMS au WhatsApp, kuandika kwa mikopo ya AI, kujisajili kwa utumaji ujumbe wa maandishi wa US — kinakataliwa kwa msaidizi, ili agizo lililoeleweka vibaya lisiweze kuwafikia wateja wako kamwe. Msaidizi huandaa rasimu; unabonyeza Tuma kwenye dashibodi au unaita API mwenyewe. Siri kama vile nenosiri la SMTP pia hazipitishwi kupitia msaidizi kamwe: ziweke kwenye dashibodi.

Vikomo

• Maombi 1,200 kwa dakika kwa kila mtu au ufunguo wa API, na maombi 6,000 kwa dakika kwa kila shirika. Kikomo chenye kubana zaidi kati ya hivyo viwili ndicho kinachotumika.
• Maombi 600 kwa dakika kwa kila muunganisho wa MCP.
• Ukivuka kikomo, jibu ni 429 lenye kijajuu cha Retry-After: subiri idadi hiyo ya sekunde.
• Kuongeza washiriki wa orodha huchukua anwani zisizozidi 1,000 kwa kila ombi; posho za anwani na barua pepe za mpango wako zinatumika kwa kila kitu unachofanya kupitia API.

Hitilafu

Kila hitilafu ina muundo uleule:

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

code haibadiliki kamwe kwa tatizo lile lile, kwa hivyo ijaribu badala ya message. Nukuu request_id unapowasiliana na usaidizi. Majibu utakayokutana nayo: 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 CONFLICT, 422 UNPROCESSABLE_ENTITY, 429 TOO_MANY_REQUESTS. 403 inamaanisha ufunguo au muunganisho hauna idhini iliyotajwa kwenye orodha iliyo hapa chini; 404 pia inajumuisha kitu katika shirika ambacho huwezi kukiona; 422 huorodhesha kila sehemu isiyo sahihi katika details; baada ya 429, subiri idadi ya sekunde iliyo kwenye kichwa cha Retry-After.

Webhooks

Matokeo ya uwasilishaji huingia ndani ya Zinn® Campaigns kutoka kwa mtoa huduma anayetuma barua pepe yako:

• Ukiwa na mtoa huduma wako mwenyewe (kwa mfano Resend), hifadhi siri yake ya kutia sahihi ya webhook kwenye muunganisho wa utumaji katika dashibodi (Kampeni → Utumaji). Unapata webhook_url; elekeza matukio ya mtoa huduma ya iliyowasilishwa, iliyokataliwa na iliyolalamikiwa hapo. Kukataliwa au malalamiko ya barua taka huondoa anwani mara moja kwenye utumaji wa siku zijazo.
• Ukiwa na utumaji wa Zinn®, hakuna chochote cha kusanidi.

Soma matokeo kwa kutumia shughuli za ripoti (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).

Kila shughuli ya Kampeni

Muhtasari

• GET /v1/email-marketing — Muhtasari wa Zinn® Campaigns kwa shirika moja. Shughuli getEmailMarketingOverview. Idhini zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.

Kampeni za barua pepe

• GET /v1/email-marketing/campaigns — Kampeni za barua pepe, mpya zaidi kwanza, ukurasa mmoja wa keyset. Operesheni listEmailMarketingCampaigns. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/campaigns — Unda rasimu ya kampeni ya barua pepe. Operesheni createEmailMarketingCampaign. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• GET /v1/email-marketing/campaigns/{campaign_id} — Kampeni moja ya barua pepe. Operesheni getEmailMarketingCampaign. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• PATCH /v1/email-marketing/campaigns/{campaign_id} — Hariri rasimu (au kampeni iliyokataliwa, ambayo inarudi kuwa rasimu). Operesheni updateEmailMarketingCampaign. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/lint — Kagua nakala ya kampeni kwa matatizo ya uwasilishaji kabla haijatumwa. Operesheni lintEmailMarketingCampaign. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/report — Nambari za kampeni. Operesheni getEmailMarketingCampaignReport. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/send — Anza kutuma kampeni kwa orodha yake. Operesheni ya sendEmailMarketingCampaign. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: API na dashibodi pekee: inatumia pesa au salio lililotengwa, kwa hivyo mtu anapaswa kuibonyeza (hutuma kwa wapokeaji halisi na kutumia salio lililotengwa).
• POST /v1/email-marketing/campaigns/{campaign_id}/test — Tuma nakala moja ya jaribio sasa kwa mwanachama wa shirika. Operesheni ya testEmailMarketingCampaign. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/translate — Tafsiri kampeni katika kila lugha ya mwasiliani inayokosekana au iliyopitwa na wakati. Operesheni ya translateEmailMarketingCampaign. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/translations — Kila lugha ya mwasiliani ya orodha ya kampeni na iwapo tafsiri yake ni ya sasa. Operesheni ya listEmailMarketingCampaignTranslations. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.

Kuandika kwa kutumia AI

• POST /v1/email-marketing/ai/write — Andika rasimu ya barua pepe ya kampeni kutoka kwa maelezo mafupi ukitumia Zinn® AI. Operesheni writeEmailMarketingCampaignWithAi. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: API na dashibodi pekee: inatumia pesa au kiwango kilichotengwa, kwa hivyo mtu huibonyeza (uandishi wa AI hutumia salio la AI).

Zana za chapa

• GET /v1/email-marketing/brand-kit — Zana za chapa za shirika (jina, nembo, rangi, fonti, sauti). Operesheni getEmailMarketingBrandKit. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• PUT /v1/email-marketing/brand-kit — Hariri zana za chapa. Operesheni updateEmailMarketingBrandKit. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/brand-kit/read — Soma zana za chapa kutoka kwa tovuti ya shirika. Operesheni readEmailMarketingBrandKit. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.

Anwani na ujumbe wa mara moja

• GET /v1/email-marketing/contacts — Anwani za shirika, ukurasa mmoja wa keyset kwa wakati mmoja. Operesheni listEmailMarketingContacts. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/contacts/{contact_id}/messages — Tuma SMS moja kwa anwani moja, ikilipiwa kutoka kwa salio la mikopo la Zinn®. Operesheni sendEmailMarketingMessage. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: API na dashibodi pekee: hutumia pesa au posho, kwa hivyo mtu huibonyeza (ujumbe wa mara moja kwa anwani hutumia posho).
• GET /v1/email-marketing/messages — Ujumbe wa SMS na WhatsApp ambao shirika lilituma, mpya zaidi kwanza, ukurasa mmoja wa keyset. Operesheni listEmailMarketingMessages. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.

Orodha

• GET /v1/email-marketing/lists — Orodha za barua pepe za shirika zikiwa na idadi ya waliojisajili / waliojiondoa. Operesheni ya listEmailMarketingLists. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/lists — Unda orodha ya barua pepe (au rudisha ile yenye jina hilo). Operesheni ya createEmailMarketingList. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/lists/{list_id}/members — Ongeza anwani kwenye orodha kupitia anwani ya barua pepe (zisizozidi 1,000 kwa ombi moja). Operesheni ya addEmailMarketingListMembers. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.

Uingizaji

• GET /v1/email-marketing/imports — Uingizaji wa awali wa anwani, mpya zaidi kwanza, ukurasa mmoja wa keyset kwa wakati mmoja. Operesheni ya listEmailMarketingImports. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/imports — Ingiza fungu moja la anwani pamoja na uthibitisho wake wa idhini. Operesheni ya createEmailMarketingImport. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.

Fomu za kujisajili

• GET /v1/email-marketing/forms — Fomu za kujisajili (uthibitisho mara mbili), mpya zaidi kwanza, ukurasa mmoja wa seti ya vitufe. Operesheni listEmailMarketingForms. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/forms — Unda fomu ya kujisajili inayoongeza watu waliothibitishwa kwenye orodha moja. Operesheni createEmailMarketingForm. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• DELETE /v1/email-marketing/forms/{form_id} — Futa fomu ya kujisajili (watu ambao tayari wamethibitishwa hubaki kwenye orodha). Operesheni deleteEmailMarketingForm. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• PATCH /v1/email-marketing/forms/{form_id} — Badilisha fomu ya kujisajili (maneno, orodha, kuelekeza kwingine, kuwasha au kuzima). Operesheni updateEmailMarketingForm. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.

Miunganisho ya kutuma

• GET /v1/email-marketing/senders — Miunganisho ya kutuma ya shirika. Operesheni listEmailMarketingSenders. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa kisaidizi cha AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/senders — Unganisha mtumaji wa kampeni (utume wa Zinn®, au seva ya SMTP ya mteja mwenyewe). Operesheni createEmailMarketingSender. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa kisaidizi cha AI: API na dashibodi pekee: hubeba siri ambayo haipaswi kamwe kufikia kielelezo cha AI (sehemu kuu ni nenosiri la SMTP).
• DELETE /v1/email-marketing/senders/{sender_id} — Ondoa muunganisho wa kutuma na nenosiri lake lililohifadhiwa. Operesheni deleteEmailMarketingSender. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa kisaidizi cha AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/senders/{sender_id}/verify — Thibitisha muunganisho wa kutuma unafanya kazi, bila kutuma chochote. Operesheni verifyEmailMarketingSender. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa kisaidizi cha AI: ndiyo, kupitia MCP.
• PUT /v1/email-marketing/senders/{sender_id}/webhook — Hifadhi siri ya kusaini ya webhook ya mtoa huduma wako wa barua pepe kwa muunganisho huu. Operesheni setEmailMarketingSenderWebhook. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa kisaidizi cha AI: inaitwa na mfumo mwingine (mtoa huduma au mgeni), si nanyi (huhifadhi siri ya webhook ya mtoa huduma).

SMS na WhatsApp

• GET /v1/email-marketing/sms — Kile ambacho skrini ya SMS inahitaji — imefunguliwa?, imesitishwa?, salio la mikopo na bei. Operesheni getEmailMarketingSms. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• GET /v1/email-marketing/sms/campaigns — Kampeni za SMS za jumla, mpya zaidi kwanza, ukurasa mmoja wa keyset. Operesheni listSmsMarketingCampaigns. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/sms/campaigns — Unda rasimu ya SMS kwa orodha. Operesheni createSmsMarketingCampaign. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id} — Kampeni moja ya SMS ya jumla. Operesheni getSmsMarketingCampaign. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — Hariri rasimu (au kampeni iliyokataliwa, ambayo inarudi kwenye rasimu). Operesheni updateSmsMarketingCampaign. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — Nambari za takwimu za kampeni ya SMS ya jumla. Operesheni getSmsMarketingCampaignReport. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — Anza kutuma SMS kwa kila mtu kwenye orodha yake aliyekubali kupokea SMS — au endeleza ile iliyositishwa kwa ajili ya salio. Operesheni sendSmsMarketingCampaign. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: API na dashibodi pekee: inatumia pesa au mgawo, kwa hivyo mtu huibonyeza (hutuma ujumbe unaolipwa wa SMS/WhatsApp).
• GET /v1/email-marketing/sms/registrations/us — Usajili wa US 10DLC wa shirika hili, na gharama zake. Operesheni getEmailMarketingUsRegistration. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/sms/registrations/us — Wasilisha chapa na kampeni ya shirika hili kwa ajili ya US 10DLC (inayotozwa wakati wa kuwasilisha). Operesheni submitEmailMarketingUsRegistration. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: API na dashibodi pekee: inatumia pesa au mgawo, kwa hivyo mtu huibonyeza (usajili wa US 10DLC unahusisha ada za mtoa huduma).

Kampeni kupitia huduma yako mwenyewe ya barua pepe (violezo, sehemu, vizuizi)

• GET /v1/campaigns — Kampeni za shirika. Operesheni listCampaigns. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/campaigns — Unda kampeni kutoka kwenye kiolezo na hadhira. Operesheni createCampaign. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• DELETE /v1/campaigns/esp — Tenganisha akaunti ya mtoa huduma na uondoe ufunguo wake uliohifadhiwa. Operesheni disconnectEsp. Kutoka kwa msaidizi wa AI: API na dashibodi pekee: inabeba siri ambayo haipaswi kamwe kufikia modeli ya AI (huharibu ufunguo wa ESP uliohifadhiwa).
• GET /v1/campaigns/esp — Akaunti ya mtoa huduma wa barua pepe ya shirika yenyewe. Operesheni getEspConnection. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/campaigns/esp — Unganisha akaunti ya mtoa huduma wa barua pepe. Operesheni connectEsp. Kutoka kwa msaidizi wa AI: API na dashibodi pekee: inabeba siri ambayo haipaswi kamwe kufikia modeli ya AI (sehemu kuu ni ufunguo wa API ya ESP).
• POST /v1/campaigns/esp/verify — Dhibitisha kuwa akaunti ya mtoa huduma inafanya kazi na usome vikoa vyake vilivyothibitishwa. Operesheni verifyEspConnection. Kutoka kwa msaidizi wa AI: API na dashibodi pekee: inabeba siri ambayo haipaswi kamwe kufikia modeli ya AI (hukagua upya ufunguo wa ESP uliohifadhiwa).
• POST /v1/campaigns/preview — Render kiolezo chenye thamani za mfano. Operesheni previewCampaignTemplate. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• GET /v1/campaigns/segments — Sehemu za hadhira zilizohifadhiwa. Operesheni listCampaignSegments. Ruhusa zilizokaguliwa: campaigns.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/campaigns/segments — Hifadhi sehemu mpya ya hadhira. Operesheni createCampaignSegment. Ruhusa zilizokaguliwa: campaigns.manage. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• GET /v1/campaigns/segments/fields — Msamiati wa vichujio, orodha zake za thamani na lebo za kipekee. Operesheni ya getCampaignSegmentFields. Ruhusa zilizokaguliwa: campaigns.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/campaigns/segments/preview — Idadi ya watu wanaofikiwa, wao ni nani, na nani ambao hawajajumuishwa. Operesheni ya previewCampaignSegment. Ruhusa zilizokaguliwa: campaigns.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• DELETE /v1/campaigns/segments/{segmentId} — Hifadhi sehemu kwenye kumbukumbu. Operesheni ya archiveCampaignSegment. Ruhusa zilizokaguliwa: campaigns.manage. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• GET /v1/campaigns/segments/{segmentId} — Sehemu moja iliyohifadhiwa. Operesheni ya getCampaignSegment. Ruhusa zilizokaguliwa: campaigns.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• PATCH /v1/campaigns/segments/{segmentId} — Badilisha jina la sehemu au ubadilishe vichujio vyake. Operesheni ya updateCampaignSegment. Ruhusa zilizokaguliwa: campaigns.manage. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• GET /v1/campaigns/suppressions — Anwani ambazo hazipaswi kupokea jumbe za uuzaji. Operesheni ya listCampaignSuppressions. Ruhusa zilizokaguliwa: campaigns.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/campaigns/suppressions — Ongeza anwani kwenye orodha ya kuzuiwa. Operesheni ya createCampaignSuppression. Ruhusa zilizokaguliwa: campaigns.manage. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• GET /v1/campaigns/tags — Ubao wa lebo maalum (magic-tag) unaotolewa na kitunzi cha kampeni. Operesheni listCampaignTags. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• GET /v1/campaigns/templates — Violezo vya kampeni vya shirika. Operesheni listCampaignTemplates. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/campaigns/templates — Tunga kiolezo cha kampeni. Operesheni createCampaignTemplate. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• DELETE /v1/campaigns/templates/{templateId} — Hifadhi kiolezo kwenye kumbukumbu na uondoe vyanzo vyake vya tafsiri. Operesheni archiveCampaignTemplate. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• GET /v1/campaigns/templates/{templateId} — Kiolezo kimoja cha kampeni. Operesheni getCampaignTemplate. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• PUT /v1/campaigns/templates/{templateId} — Hariri kiolezo cha kampeni. Operesheni updateCampaignTemplate. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/campaigns/unsubscribe — Jiondoe kwenye orodha ya uuzaji. Hakuna akaunti inayohitajika. Operesheni unsubscribeFromCampaigns. Kutoka kwa msaidizi wa AI: API na dashibodi pekee: inabeba siri ambayo haipaswi kamwe kufikia modeli ya AI (inachukua tokeni ya kujiondoa iliyotiwa saini ya mpokeaji).
• DELETE /v1/campaigns/{campaignId} — Futa kampeni na uondoe safu mlalo zake za uwasilishaji. Operesheni deleteCampaign. Kutoka kwa msaidizi wa AI: API na dashibodi pekee: inahitaji ruhusa ambayo miunganisho ya AI haipewi (kufuta kampeni ya ESP kunahitaji campaigns.send).
• GET /v1/campaigns/{campaignId} — Kampeni moja na ripoti yake ya uwasilishaji. Operesheni getCampaign. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/campaigns/{campaignId}/control — Sitisha kwa muda, endeleza au ghairi utumaji unaoendelea. Operesheni controlCampaign. Kutoka kwa msaidizi wa AI: API na dashibodi pekee: inagharimu pesa au salio lililotengwa, kwa hivyo mtu huibonyeza (husitisha/huendeleza utumaji unaoendelea).
• POST /v1/campaigns/{campaignId}/send — Anzisha utumaji thabiti. Operesheni sendCampaign. Kutoka kwa msaidizi wa AI: API na dashibodi pekee: inagharimu pesa au salio lililotengwa, kwa hivyo mtu huibonyeza (hutuma kampeni ya ESP kwa wapokeaji halisi).
• POST /v1/campaigns/{campaignId}/test — Tuma ujumbe mmoja halisi kwenye chaneli ambayo kampeni itatumia kiuhalisia. Operesheni testSendCampaign. Kutoka kwa msaidizi wa AI: API na dashibodi pekee: inahitaji ruhusa ambayo miunganisho ya AI haipewi (utumaji wa majaribio wa ESP unahitaji campaigns.send).

Kurasa za umma na webhook zinazoingia

• GET /v1/public/email-marketing/c/{token} — Kihesabu mibofyo. Hurekodi mbofyo mmoja kwa kila mpokeaji na kuelekeza upya kwenye kiungo asili. Operesheni emailMarketingClick. Kutoka kwa msaidizi wa AI: ukurasa ambao wapokeaji wako hufungua kutoka kwa barua pepe (uelekezaji upya wa ufuatiliaji wa mibofyo).
• GET /v1/public/email-marketing/f/{public_id} — Ukurasa uliopangishwa wa fomu ya kujisajili (hakuna kuingia). Operesheni emailMarketingFormPage. Kutoka kwa msaidizi wa AI: ukurasa ambao wapokeaji wako hufungua kutoka kwa barua pepe (ukurasa wa umma wa fomu ya kujisajili).
• POST /v1/public/email-marketing/f/{public_id} — Wasilisha fomu ya kujisajili (ukurasa unaopangishwa, uliopachikwa au JSON). Operesheni emailMarketingFormSubmit. Kutoka kwa msaidizi wa AI: inaitwa na mfumo mwingine (mtoa huduma au mgeni), siyo nanyi (mgeni anawasilisha fomu ya kujisajili).
• GET /v1/public/email-marketing/fc — Ukurasa wa uthibitisho wa idhini mara mbili (bila kuingia katika akaunti). Operesheni emailMarketingFormConfirmPage. Kutoka kwa msaidizi wa AI: ukurasa ambao wapokeaji wenu wanafungua kutoka kwenye barua pepe (ukurasa wa uthibitisho wa idhini mara mbili).
• POST /v1/public/email-marketing/fc — Thibitisha usajili (huongeza mtu kwenye orodha pamoja na rekodi ya idhini). Operesheni emailMarketingFormConfirm. Kutoka kwa msaidizi wa AI: inaitwa na mfumo mwingine (mtoa huduma au mgeni), siyo nanyi (mgeni anathibitisha idhini mara mbili).
• GET /v1/public/email-marketing/o/{token} — Picha ya ufuatiliaji wa ufunguzi (GIF ya 1x1). Huhesabu ufunguzi mmoja kwa kila mpokeaji. Operesheni emailMarketingOpenPixel. Kutoka kwa msaidizi wa AI: ukurasa ambao wapokeaji wenu wanafungua kutoka kwenye barua pepe (pikseli ya kufuatilia ufunguzi).
• GET /v1/public/email-marketing/u/{token} — Kiungo cha kijachini cha kujiondoa (bila kuingia katika akaunti). Operesheni emailMarketingUnsubscribePage. Kutoka kwa msaidizi wa AI: ukurasa ambao wapokeaji wenu wanafungua kutoka kwenye barua pepe (ukurasa wa kujiondoa).
• POST /v1/public/email-marketing/u/{token} — Kujiondoa kwa mbofyo mmoja kulingana na RFC 8058 (na kitufe cha "sitisha kila kitu" cha ukurasa). Operesheni emailMarketingUnsubscribeOneClick. Kutoka kwa msaidizi wa AI: inaitwa na mfumo mwingine (mtoa huduma au mgeni), siyo nanyi (kujiondoa kwa mbofyo mmoja kwa RFC 8058).
• GET /v1/public/email-marketing/warmup-u/{token} — Kiungo cha kujiondoa kwenye barua pepe ya kupasha joto ya kundi la uuzaji (bila kuingia). Operesheni emailMarketingWarmupUnsubscribePage. Kutoka kwa msaidizi wa AI: ukurasa ambao wapokeaji wenu hufungua kutoka kwa barua pepe (ukurasa wa kujiondoa wa kupasha joto).
• POST /v1/public/email-marketing/warmup-u/{token} — Kujiondoa kwa mbofyo mmoja kulingana na RFC 8058 kutoka kwenye barua pepe ya kupasha joto. Operesheni emailMarketingWarmupUnsubscribeOneClick. Kutoka kwa msaidizi wa AI: inaitwa na mfumo mwingine (mtoa huduma au mgeni), siyo nanyi (kujiondoa kwa mbofyo mmoja wa kupasha joto).
• POST /v1/webhooks/campaign-events — Kupokea tukio la uwasilishaji lililosainiwa kutoka kwa mtoa huduma wa barua pepe. Operesheni receiveCampaignDeliveryWebhook. Kutoka kwa msaidizi wa AI: inaitwa na mfumo mwingine (mtoa huduma au mgeni), siyo nanyi (webhook ya uwasilishaji ya ESP iliyosainiwa).
• POST /v1/webhooks/campaigns/telnyx — Majibu ya SMS yanayoingia (STOP / START) kutoka kwa mtoa huduma wetu wa SMS. Operesheni receiveCampaignsTelnyxInbound. Kutoka kwa msaidizi wa AI: inaitwa na mfumo mwingine (mtoa huduma au mgeni), siyo nanyi (webhook inayoingia ya Telnyx iliyosainiwa).
• POST /v1/webhooks/email-marketing/{connection_id} — Matukio ya uwasilishaji ya mtoa huduma wa barua pepe wa mteja mwenyewe kwa muunganisho mmoja wa kutuma. Operesheni receiveEmailMarketingProviderWebhook. Kutoka kwa msaidizi wa AI: inaitwa na mfumo mwingine (mtoa huduma au mgeni), si wewe (webhook ya mtoa huduma-mtumaji iliyotiwa saini).

Michirizi ya Kazi

• GET /v1/email-marketing/flows — Michirizi ya barua pepe (ukaribisho, mfululizo, tarehe ya kila mwaka), ukurasa mmoja wa keyset. Operesheni listEmailMarketingFlows. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/flows — Unda mchirizi wa kazi (huanza kama rasimu). Operesheni createEmailMarketingFlow. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• DELETE /v1/email-marketing/flows/{flow_id} — Futa mchirizi wa kazi na usajili wake (utekelezaji uliotumwa husalia, kama kampeni). Operesheni deleteEmailMarketingFlow. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• GET /v1/email-marketing/flows/{flow_id} — Mchirizi mmoja wa kazi wenye hatua zake na ripoti yake (waliosajiliwa, wanaoendelea, utekelezaji na wapokeaji kwa kila hatua). Operesheni getEmailMarketingFlow. Ruhusa zilizokaguliwa: email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• PATCH /v1/email-marketing/flows/{flow_id} — Badilisha mtiririko; steps, ikitolewa, inachukua nafasi ya mfuatano mzima. Operesheni ya updateEmailMarketingFlow. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/flows/{flow_id}/activate — Washa mtiririko; ni watu wanaojiunga na orodha kuanzia sasa ndio wataosajiliwa. Operesheni ya activateEmailMarketingFlow. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.
• POST /v1/email-marketing/flows/{flow_id}/pause — Sitisha mtiririko kwa muda; hatua zinazostahili zitasubiri na hakuna mtu mpya atakayetumiwa barua pepe hadi utakapowashwa tena. Operesheni ya pauseEmailMarketingFlow. Ruhusa zilizokaguliwa: email_marketing.manage, email_marketing.view. Kutoka kwa msaidizi wa AI: ndiyo, kupitia MCP.