Zinn® Campaigns API iyo MCP: hagaha horumariyaha

Wax kasta oo aad ku samayn karto Zinn® Campaigns ee ku yaal dashboard-ka waxaad sidoo kale ku samayn kartaa API-ga, inta badanna waxaad kaga samayn kartaa caawiye AI ah oo ku xidhan koontadaada xagga MCP. Hagahan waxa uu daboolayaa gelitaanka, oggolaanshaha, tusaale la shaqeeyay oo labada dhinacba ah, xaddidaadaha, khaladaadka iyo mid kasta oo ka mid ah 89-ka hawlgal ee Campaigns. Liiska hawlgallada ee hoose waxaa laga soo saaray qeexitaanka API-gayaga, markaa had iyo jeer wuu la mid yahay waxa API-gu qabto. Goob kasta oo hawlgal kasta ku saabsan waxay ku jirtaa tixraaca API ee zinndigital.com/developers/api/zinn-campaigns.

Gelitaanka

• Furayaasha API. Ka dhex samee fure dashboard-ka hoosta Dejinta → Furayaasha API oo u dir sidatan Authorization: Bearer zdk_live_… (furaha zdk_test_… wuxuu ku shaqeeyaa habka sandbox-ka). Sii furaha rukhsadaha Campaigns ee uu u baahan yahay oo keliya, wax intaas ka badanna ha siin.
• Kaaliyayaasha AI (MCP). Ku xidh Claude, ChatGPT, Cursor ama macmiil kasta oo MCP ah https://api.zinndigital.com/v1/mcp, adigoo ka soo galaya barnaamijka dhexdiisa ama isticmaalaya calaamadda xidhiidhka (zmcp_live_…). Eeg Ku xidhida Claude, Cursor ama ChatGPT koontadaada. Shaashadda oggolaanshaha, sax rukhsadaha Zinn® Campaigns.
• Rukhsadaha. email_marketing.view waxay akhrisaa ololayaasha, liisaska, xiriirada, foomamka, soo-dirayaasha, dejinta SMS-ka iyo warbixinnada; email_marketing.manage waxay abuurtaa waxna ka beddeshaa iyaga. Ololayaasha aad ku dirto adeeggaaga iimaylka waxay isticmaalaan campaigns.view iyo campaigns.manage.
• Dib-u-iibiyayaasha. Gudbi org_id si aad ugu hawlgasho mid ka mid ah hay'adaha macmiilkaaga ah. Ka tag marka furahaaga ama xidhiidhkaagu gaadho hal hay'ad oo keliya.

Tusaale: ku samee qabyo-qoraalka ololaha API-ga

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

Jawaabtu waa 201 oo ay la socoto qabyo-qoraalku. Ku tijaabi POST /v1/email-marketing/campaigns/{campaign_id}/test, kaga hubi GET /v1/email-marketing/campaigns/{campaign_id}/lint, oo ku dir POST /v1/email-marketing/campaigns/{campaign_id}/send.

Tusaale: isla qabyo-qoraalka oo ka yimid caawiyaha AI

Weydii caawiyahaaga adigoo adeegsanaya erayo cad, tusaale ahaan "samee qabyo-qoraal iimayl Zinn® Campaigns ah oo loogu magac daray Spring sale oo cinwaankiisuna yahay 'Our spring sale starts today'". Daaha gadaashiisa waxa ay hawlgalka kaga helaysaa api_operations_search, waxa ay xuduudaheeda kaga akhrinaysaa api_operation_get, waxayna ku fulinaysaa 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"
      }
    }
  }
}

Waxa uusan caawiyuhu qaban doonin. Wax kasta oo wax u diraya qaatahaaga ama kharash gareynaya lacag ama xaddid — dirista olole, dirista fariimaha SMS ama WhatsApp, wax ku qorista buundooyinka AI, iska diiwaangelinta fariimaha qoraalka ee US — waa laga diidayaa caawiyaha, sidaas darteed tilmaam si khaldan loo fahmay marnaba ma gaari karto macaamiishaada. Caawiyuhu wuxuu diyaariyaa qabyo-qoraalka; adigu waxaad ku riixaysaa Dir gudaha dashboard-ka ama waxaad wacaysaa API-ga laftaadu. Siraha sida erayga sirta ah ee SMTP sidoo kale marnaba lama dhex mariyo caawiyaha: ku geli iyaga dashboard-ka.

Xaddidaadaha

• 1,200 oo codsi daqiiqaddii qof kasta ama furaha API kasta, iyo 6,000 oo codsi daqiiqaddii hay'ad kasta. Waxaa khuseeya labada midka ka adag.
• 600 oo codsi daqiiqaddii xiriir kasta oo MCP ah.
• Haddii xadka la dhaafo, jawaabtu waa 429 oo wadata madax Retry-After: sug intaas oo ilbiriqsi ah.
• Ku darista xubnaha liiska waxay qaadataa ugu badnaan 1,000 cinwaan codsi kasta; xaddidyada xiriirada iyo iimayllada ee qorshahaaga waxay khuseeyaan wax kasta oo aad ku qabato API-ga.

Khaladaadka

Khalad kasta wuxuu leeyahay qaab isku mid ah:

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

code waligii isma beddelo dhibaatada isku midka ah dhexdeeda, markaa baadh isaga halkii aad ka baadhi lahayd message. Sheeg request_id markaad la xidhiidhayso taageerada. Jawaabaha aad la kulmi doonto: 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 CONFLICT, 422 UNPROCESSABLE_ENTITY, 429 TOO_MANY_REQUESTS. 403 waxay ka dhigan tahay in furaha ama xidhiidhku uusan haysan oggolaansho ay liiska hoose xustay; 404 waxay sidoo kale daboolaysaa wax ku jira urur aadan arki karin; 422 waxay ku taxdaa goob kasta oo khaldan details; ka dib 429, sug tirada ilbidhiqsiyada ku qoran madaxa Retry-After.

Webhooks

Natiijooyinka gaarsiintu waxay Zinn® Campaigns gudaha ugu yimaadaan bixiyaha soo dira iimaylkaaga:

• Markaad haysato bixiyahaaga gaarka ah (tusaale ahaan Resend), ku kaydi sirta saxiixa webhook-kiisa xidhiidhka dirista ee ku yaal dashboard-ka (Ololeyaasha → Dirista). Waxaad helaysaa webhook_url; ku toosi dhacdooyinka delivered, bounced iyo complained ee bixiyaha. Dib-u-soo-noqoshada (bounce) ama cabashada spam-ka waxay cinwaanka isla markiiba ka saaraysaa dirista mustaqbalka.
• Dirista Zinn®, ma jiraan wax la habeeyo.

Ku akhri natiijooyinka hawlgallada warbixinta (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).

Hawlgal kasta oo Campaigns ah

Guudmar

• GET /v1/email-marketing — Guudmarka Zinn® Campaigns ee hal urur. Hawlgalka getEmailMarketingOverview. Oggolaanshaha la hubiyay: email_marketing.view. Ka yimid kaaliyaha AI: haa, iyada oo loo marayo MCP.

Ololeyaasha iimaylka

• GET /v1/email-marketing/campaigns — Ololayaasha iimaylka, kuwa ugu cusub ayaa horreeya, hal bog oo keyset ah. Hawlgalka listEmailMarketingCampaigns. Oggolaanshaha la hubiyay: email_marketing.view. Ka socda caawiyaha AI: haa, iyada oo loo marayo MCP.
• POST /v1/email-marketing/campaigns — Abuur qabyo-qoraal ololaha iimaylka ah. Hawlgalka createEmailMarketingCampaign. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka socda caawiyaha AI: haa, iyada oo loo marayo MCP.
• GET /v1/email-marketing/campaigns/{campaign_id} — Hal olole iimayl ah. Hawlgalka getEmailMarketingCampaign. Oggolaanshaha la hubiyay: email_marketing.view. Ka socda caawiyaha AI: haa, iyada oo loo marayo MCP.
• PATCH /v1/email-marketing/campaigns/{campaign_id} — Wax ka beddel qabyo-qoraal (ama olole la diiday, kaas oo dib ugu noqda qabyo-qoraal). Hawlgalka updateEmailMarketingCampaign. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka socda caawiyaha AI: haa, iyada oo loo marayo MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/lint — Hubi qoraalka ololaha dhibaatooyinka gaarsiinta ka hor inta aan la dirin. Hawlgalka lintEmailMarketingCampaign. Oggolaanshaha la hubiyay: email_marketing.view. Ka socda caawiyaha AI: haa, iyada oo loo marayo MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/report — Tirooyinka ololaha. Hawlgalka getEmailMarketingCampaignReport. Oggolaanshaha la hubiyay: email_marketing.view. Ka socda caawiyaha AI: haa, iyada oo loo marayo MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/send — Bilow u dirista ololaha liiskiisa. Hawlgalka sendEmailMarketingCampaign. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka socda caawiyaha AI: API iyo dashboard-ka keliya: waxa ay kharash garaysaa lacag ama qoonde, sidaas darteed qof ayaa riixaya (waxay u dirtaa qaataha dhabta ah waxayna kharash garaysaa qoonde).
• POST /v1/email-marketing/campaigns/{campaign_id}/test — Hadda u dir hal nuqul oo tijaabo ah xubin ka tirsan ururka. Hawlgalka testEmailMarketingCampaign. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka socda caawiyaha AI: haa, iyada oo loo marayo MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/translate — U turjun olole luqad kasta oo xiriir ah oo maqan ama duugowday. Hawlgalka translateEmailMarketingCampaign. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka socda caawiyaha AI: haa, iyada oo loo marayo MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/translations — Luqad kasta oo xiriir ah oo ka tirsan liiska ololaha iyo haddii turjumaaddiisu ay tahay mid hadda socota. Hawlgalka listEmailMarketingCampaignTranslations. Oggolaanshaha la hubiyay: email_marketing.view. Ka socda caawiyaha AI: haa, iyada oo loo marayo MCP.

Ku qorista AI

• POST /v1/email-marketing/ai/write — Ka qor qabyo-qoraalka iimaylka ololaha warbixin kooban adigoo isticmaalaya Zinn® AI. Hawlgalka writeEmailMarketingCampaignWithAi. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Laga helo kaaliyaha AI: API iyo muraayadda xakamaynta keliya: waxa ay kharash garaysaa lacag ama xaddiga loo oggol yahay, sidaas darteed qof ayaa riixaya (wax ku qorista AI waxay kharash garaysaa dhibcaha AI).

Xidhmada summada

• GET /v1/email-marketing/brand-kit — Xidhmada summada ururka (magaca, astaanta, midabbada, farta, codka). Hawlgalka getEmailMarketingBrandKit. Oggolaanshaha la hubiyay: email_marketing.view. Laga helo kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• PUT /v1/email-marketing/brand-kit — Wax ka beddel xidhmada summada. Hawlgalka updateEmailMarketingBrandKit. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Laga helo kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• POST /v1/email-marketing/brand-kit/read — Ka akhri xidhmada summada bogga internetka ee ururka. Hawlgalka readEmailMarketingBrandKit. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Laga helo kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.

Xiriirrada iyo farriimaha mar keliya ah

• GET /v1/email-marketing/contacts — Xiriirada ururka, hal bog oo keyset ah mar kasta. Hawlgalka listEmailMarketingContacts. Oggolaanshaha la hubiyay: email_marketing.view. Ka socda kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• POST /v1/email-marketing/contacts/{contact_id}/messages — U dir hal SMS hal xiriir, oo laga bixiyay haraaga dhibcaha Zinn®. Hawlgalka sendEmailMarketingMessage. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka socda kaaliyaha AI: API iyo muraayadda maamulka oo keliya: waxa ay isticmaashaa lacag ama xaddiga laguu oggol yahay, sidaas darteed qof ayaa riixaya (farriin mar keliya loo diro xiriir waxay isticmaashaa xaddiga laguu oggol yahay).
• GET /v1/email-marketing/messages — Farriimaha SMS iyo WhatsApp ee ururku diray, kuwa ugu cusub ayaa horreeya, hal bog oo keyset ah. Hawlgalka listEmailMarketingMessages. Oggolaanshaha la hubiyay: email_marketing.view. Ka socda kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.

Liisaska

• GET /v1/email-marketing/lists — Liisaska boostada ee hay'adda oo wata tirada kuwa iska diiwaangeliyay / ka noqday diiwaangelinta. Hawlgalka listEmailMarketingLists. Oggolaanshaha la hubiyay: email_marketing.view. Ka socda caawiyaha AI: haa, iyada oo loo marayo MCP.
• POST /v1/email-marketing/lists — Samee liis boosto (ama soo celi midka magacaas leh). Hawlgalka createEmailMarketingList. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka socda caawiyaha AI: haa, iyada oo loo marayo MCP.
• POST /v1/email-marketing/lists/{list_id}/members — Kula dar xiriirro liis adiga oo adeegsanaya cinwaanka iimaylka (ugu badnaan 1,000 codsi kasta). Hawlgalka addEmailMarketingListMembers. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka socda caawiyaha AI: haa, iyada oo loo marayo MCP.

Imports

• GET /v1/email-marketing/imports — Soo dejintii hore ee xiriirrada, kuwa ugu cusub ayaa horreeya, hal bog keyset ah markiiba. Hawlgalka listEmailMarketingImports. Oggolaanshaha la hubiyay: email_marketing.view. Ka socda caawiyaha AI: haa, iyada oo loo marayo MCP.
• POST /v1/email-marketing/imports — Soo deji hal qayb oo xiriirro ah oo ay weheliso caddeynta oggolaanshaha. Hawlgalka createEmailMarketingImport. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka socda caawiyaha AI: haa, iyada oo loo marayo MCP.

Sign-up forms

• GET /v1/email-marketing/forms — Foomamka is-diiwaangelinta (labanlaab xaqiijin ah), kuwa ugu cusub ayaa ugu horreeya, hal bog oo xiriir ah. Hawlgalka listEmailMarketingForms. Ogolaanshaha la hubiyay: email_marketing.view. Laga helo kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• POST /v1/email-marketing/forms — Samee foom is-diiwaangelin ah oo dadka la xaqiijiyay ku daraya hal liis. Hawlgalka createEmailMarketingForm. Ogolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Laga helo kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• DELETE /v1/email-marketing/forms/{form_id} — Tirtir foomka is-diiwaangelinta (dadka hore loo xaqiijiyay waxay ku sii jirayaan liiska). Hawlgalka deleteEmailMarketingForm. Ogolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Laga helo kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• PATCH /v1/email-marketing/forms/{form_id} — Wax ka beddel foomka is-diiwaangelinta (ereyada, liiska, dib-u-hagaajinta, shididda ama daminta). Hawlgalka updateEmailMarketingForm. Ogolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Laga helo kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.

Xiriirinta dirista

• GET /v1/email-marketing/senders — Xiriirrada dirista ee hay'adda. Hawlgalka listEmailMarketingSenders. Oggolaanshaha la hubiyay: email_marketing.view. Ka yimid kaaliyaha AI: haa, iyada oo loo marayo MCP.
• POST /v1/email-marketing/senders — Ku xidh dire olole (dirista Zinn®, ama seerfarka SMTP ee macmiilka u gaarka ah). Hawlgalka createEmailMarketingSender. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka yimid kaaliyaha AI: API iyo muraayadda xakamaynta keliya: waxa ay sidataa sir aan marnaba la gaadhsiin karin nooca AI (qaybta qoraalku waa furaha sirta ah ee SMTP).
• DELETE /v1/email-marketing/senders/{sender_id} — Ka saar xiriirinta dirista iyo furaha sirta ah ee kaydsan. Hawlgalka deleteEmailMarketingSender. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka yimid kaaliyaha AI: haa, iyada oo loo marayo MCP.
• POST /v1/email-marketing/senders/{sender_id}/verify — Xaqiiji in xiriirinta diristu shaqaynayso, adiga oo aan waxba dirin. Hawlgalka verifyEmailMarketingSender. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka yimid kaaliyaha AI: haa, iyada oo loo marayo MCP.
• PUT /v1/email-marketing/senders/{sender_id}/webhook — Kaydi sirta saxiixa webhook-ka ee bixiyahaaga iimaylka ee xiriirintan. Hawlgalka setEmailMarketingSenderWebhook. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka yimid kaaliyaha AI: waxaa wacay nidaam kale (bixiye ama booqde), adiga maaha (waxay kaydisaa sirta webhook-ka bixiyaha).

SMS iyo WhatsApp

• GET /v1/email-marketing/sms — Waxa shaashadda SMS u baahan tahay — ma furan tahay?, ma hakad baa ku jira?, hadhaaga dhibcaha iyo qiimaha. Hawlgalka getEmailMarketingSms. Fasaxyada la hubiyay: email_marketing.view. Ka socda kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• GET /v1/email-marketing/sms/campaigns — Ololaha SMS-ka guud, kan ugu cusub ayaa horreeya, hal bog keyset ah. Hawlgalka listSmsMarketingCampaigns. Fasaxyada la hubiyay: email_marketing.view. Ka socda kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• POST /v1/email-marketing/sms/campaigns — Samee qabyo-qoraal SMS ah oo loogu talagalay liis. Hawlgalka createSmsMarketingCampaign. Fasaxyada la hubiyay: email_marketing.manage, email_marketing.view. Ka socda kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• GET /v1/email-marketing/sms/campaigns/{campaign_id} — Hal olole SMS guud ah. Hawlgalka getSmsMarketingCampaign. Fasaxyada la hubiyay: email_marketing.view. Ka socda kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — Wax ka beddel qabyo-qoraal (ama olole la diiday, kaas oo dib ugu noqonaya qabyo-qoraal). Hawlgalka updateSmsMarketingCampaign. Fasaxyada la hubiyay: email_marketing.manage, email_marketing.view. Ka socda kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — Tirooyinka olole SMS guud ah. Hawlgalka getSmsMarketingCampaignReport. Fasaxyada la hubiyay: email_marketing.view. Ka socda kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — Bilow u dirista SMS qof kasta oo ku jira liiskiisa oo oggolaaday SMS — ama dib u bilow mid loo hakiyay hanti darteed. Hawsha sendSmsMarketingCampaign. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka socota kaaliyaha AI: API iyo muraayadda xakamaynta keliya: waxay isticmaashaa lacag ama xaddiga la oggol yahay, markaa qof ayaa riixaya (waxay dirtaa fariimaha lacagta ah ee SMS/WhatsApp).
• GET /v1/email-marketing/sms/registrations/us — Diiwaangelinta US 10DLC ee ururkan, iyo inta ay ku kacayso midkiiba. Hawsha getEmailMarketingUsRegistration. Oggolaanshaha la hubiyay: email_marketing.view. Ka socota kaaliyaha AI: haa, iyada oo loo marayo MCP.
• POST /v1/email-marketing/sms/registrations/us — U gudbi astaanta iyo ololaha ururkan US 10DLC (waxaa lacag lagu dallacayaa marka la gudbiyo). Hawsha submitEmailMarketingUsRegistration. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka socota kaaliyaha AI: API iyo muraayadda xakamaynta keliya: waxay isticmaashaa lacag ama xaddiga la oggol yahay, markaa qof ayaa riixaya (diiwaangelinta US 10DLC waxay wadataa khidmadaha shirkadda adeegga).

Ololayaasha iyada oo loo marayo adeeggaaga iimaylka ee gaarka ah (tusaalooyinka, qaybaha, cabudhinta)

• GET /v1/campaigns — Ololayaasha ururka. Hawsha listCampaigns. Ka socota kaaliyaha AI: haa, iyada oo loo marayo MCP.
• POST /v1/campaigns — Ka samee olole tusaale iyo dadka loogu talagalay. Hawsha createCampaign. Ka socota kaaliyaha AI: haa, iyada oo loo marayo MCP.
• DELETE /v1/campaigns/esp — Ka saar koontada bixiyaha oo tirtir furaha kaydsan. Hawlgalka disconnectEsp. Ka socota caawiye AI: API iyo muraayadda xakamaynta kaliya: waxay xambarsan tahay sir aan marnaba gaadhin moodalka AI (waxay baabi'isaa furaha ESP ee kaydsan).
• GET /v1/campaigns/esp — Koontada bixiyaha iimaylka ee ururka laftiisa. Hawlgalka getEspConnection. Ka socota caawiye AI: haa, iyada oo loo marayo MCP.
• POST /v1/campaigns/esp — Ku xidh koontada bixiyaha iimaylka. Hawlgalka connectEsp. Ka socota caawiye AI: API iyo muraayadda xakamaynta kaliya: waxay xambarsan tahay sir aan marnaba gaadhin moodalka AI (qaybta xogtu waa furaha API ee ESP).
• POST /v1/campaigns/esp/verify — Xaqiiji in koontada bixiyuhu shaqaynayso oo akhri xayndaabyadeeda la xaqiijiyay. Hawlgalka verifyEspConnection. Ka socota caawiye AI: API iyo muraayadda xakamaynta kaliya: waxay xambarsan tahay sir aan marnaba gaadhin moodalka AI (waxay dib u hubisaa furaha ESP ee kaydsan).
• POST /v1/campaigns/preview — Render qaab leh qiyam tusaale ah. Hawlgalka previewCampaignTemplate. Ka socota caawiye AI: haa, iyada oo loo marayo MCP.
• GET /v1/campaigns/segments — Qaybaha dhegaystayaashaada ee kaydsan. Hawlgalka listCampaignSegments. Oggolaanshaha la hubiyay: campaigns.view. Ka socota caawiye AI: haa, iyada oo loo marayo MCP.
• POST /v1/campaigns/segments — Kaydi qayb dhegayste oo cusub. Hawlgalka createCampaignSegment. Oggolaanshaha la hubiyay: campaigns.manage. Ka socota caawiye AI: haa, iyada oo loo marayo MCP.
• GET /v1/campaigns/segments/fields — Eraybixinta shaandhada, liisaska qiimaheeda iyo summadaha sixirka. Hawlgalka getCampaignSegmentFields. Ogolaanshaha la hubiyay: campaigns.view. Ka socda kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• POST /v1/campaigns/segments/preview — Tirada dadka ay tani gaadho, cidda ay yihiin, iyo cidda ay ka reebto. Hawlgalka previewCampaignSegment. Ogolaanshaha la hubiyay: campaigns.view. Ka socda kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• DELETE /v1/campaigns/segments/{segmentId} — Kaydi qayb. Hawlgalka archiveCampaignSegment. Ogolaanshaha la hubiyay: campaigns.manage. Ka socda kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• GET /v1/campaigns/segments/{segmentId} — Hal qayb oo la keydiyay. Hawlgalka getCampaignSegment. Ogolaanshaha la hubiyay: campaigns.view. Ka socda kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• PATCH /v1/campaigns/segments/{segmentId} — Dib u magacow qayb ama beddel shaandhooyinkeeda. Hawlgalka updateCampaignSegment. Ogolaanshaha la hubiyay: campaigns.manage. Ka socda kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• GET /v1/campaigns/suppressions — Cinwaannada aan khasabka ahayn inay helin suuqgeyn. Hawlgalka listCampaignSuppressions. Ogolaanshaha la hubiyay: campaigns.view. Ka socda kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• POST /v1/campaigns/suppressions — Ku dar cinwaan liiska xakamaynta. Hawlgalka createCampaignSuppression. Ogolaanshaha la hubiyay: campaigns.manage. Ka socda kaaliyaha AI: haa, iyada oo loo marayo MCP-ga.
• GET /v1/campaigns/tags — Qeybta sumadaha sixirka ee uu bixiyo qoraaga ololuhu. Hawlgalka listCampaignTags. Laga helo kaaliyaha AI: haa, iyada oo loo marayo MCP.
• GET /v1/campaigns/templates — Qaababka ololaha ee ururka. Hawlgalka listCampaignTemplates. Laga helo kaaliyaha AI: haa, iyada oo loo marayo MCP.
• POST /v1/campaigns/templates — Samee qaab olole. Hawlgalka createCampaignTemplate. Laga helo kaaliyaha AI: haa, iyada oo loo marayo MCP.
• DELETE /v1/campaigns/templates/{templateId} — Kaydi qaabka oo ka fariisi ilaha tarjumaaddiisa. Hawlgalka archiveCampaignTemplate. Laga helo kaaliyaha AI: haa, iyada oo loo marayo MCP.
• GET /v1/campaigns/templates/{templateId} — Hal qaab olole. Hawlgalka getCampaignTemplate. Laga helo kaaliyaha AI: haa, iyada oo loo marayo MCP.
• PUT /v1/campaigns/templates/{templateId} — Wax ka beddel qaab olole. Hawlgalka updateCampaignTemplate. Laga helo kaaliyaha AI: haa, iyada oo loo marayo MCP.
• POST /v1/campaigns/unsubscribe — Ka bax liiska suuqgeynta. Koonto looma baahna. Hawlgalka unsubscribeFromCampaigns. Laga helo kaaliyaha AI: API iyo muraayadda xakamaynta kaliya: waxa ay xanbaarsan tahay sir aan marnaba gaadhin moodalka AI (waxay qaadataa calaamadda saxiixan ee ka bixitaanka qaataha).
• DELETE /v1/campaigns/{campaignId} — Tirtir olole oo ka fariisi safafkiisa gudbinta. Hawlgalka deleteCampaign. Laga helo kaaliyaha AI: API iyo muraayadda xakamaynta kaliya: waxa ay u baahan tahay oggolaansho aan la siinin isku-xidhka AI (tirtiridda ololaha ESP waxay u baahan tahay campaigns.send).
• GET /v1/campaigns/{campaignId} — Hal olole iyo warbixintiisa gudbinta. Hawlgalka getCampaign. Ka socota caawiyaha AI: haa, iyada oo loo marayo MCP.
• POST /v1/campaigns/{campaignId}/control — Haki, dib u billow ama baabi'i diris socota. Hawlgalka controlCampaign. Ka socota caawiyaha AI: API iyo muraayadda xakamaynta keliya: waxay bixisaa lacag ama gunno, sidaas darteed qof baa riixaya (waxay hakisaa/dib u billowdaa diris toos ah).
• POST /v1/campaigns/{campaignId}/send — Billow dirista joogtada ah. Hawlgalka sendCampaign. Ka socota caawiyaha AI: API iyo muraayadda xakamaynta keliya: waxay bixisaa lacag ama gunno, sidaas darteed qof baa riixaya (waxay u dirtaa olole ESP dadka dhabta ah ee qaadanaya).
• POST /v1/campaigns/{campaignId}/test — Ku dir hal farriin oo dhab ah kanaalka uu ololuhu dhab ahaan isticmaali doono. Hawlgalka testSendCampaign. Ka socota caawiyaha AI: API iyo muraayadda xakamaynta keliya: waxay u baahan tahay oggolaansho aan la siin xiriirrada AI (dirista tijaabada ESP waxay u baahan tahay campaigns.send).

Bogagga guud iyo webhooks-ka soo galaya

• GET /v1/public/email-marketing/c/{token} — Tiriyaha gujinta. Waxay diiwaangelisaa hal gujin qofkii qaataha ahba waxayna dib u toosisaa xiriirka asalka ah. Hawlgalka emailMarketingClick. Ka socota caawiyaha AI: bog ay dadkaaga qaataha ahi ka furaan iimayl (dib-u-hagaajinta la socoshada gujinta).
• GET /v1/public/email-marketing/f/{public_id} — Bog la martigeliyay oo ah foomka isdiiwaangelinta (gelitaan ma leh). Hawlgalka emailMarketingFormPage. Ka socota caawiyaha AI: bog ay dadkaaga qaataha ahi ka furaan iimayl (bogga foomka isdiiwaangelinta guud).
• POST /v1/public/email-marketing/f/{public_id} — Gudbi foomka isdiiwaangelinta (bog la martigeliyay, la dhejiyay ama JSON). Hawlgalka emailMarketingFormSubmit. Ka socda kaaliyaha AI: waxa wacaya nidaam kale (bixiye ama booqde), adiga maaha (booqde ayaa gudbinaya foomka isdiiwaangelinta).
• GET /v1/public/email-marketing/fc — Bogga xaqiijinta laba-geesoodka ah ee doorashada (ma jiro gelid). Hawlgalka emailMarketingFormConfirmPage. Ka socda kaaliyaha AI: bog ay qaatayaashaadu ka furaan iimaylka (bogga xaqiijinta laba-geesoodka ah ee doorashada).
• POST /v1/public/email-marketing/fc — Xaqiiji isdiiwaangelinta (waxay qofka ku daraysaa liiska iyada oo wadata diiwaanka oggolaanshaha). Hawlgalka emailMarketingFormConfirm. Ka socda kaaliyaha AI: waxa wacaya nidaam kale (bixiye ama booqde), adiga maaha (booqde ayaa xaqiijinaya doorashada laba-geesoodka ah).
• GET /v1/public/email-marketing/o/{token} — Sawirka la-socodka furitaanka (GIF 1x1 ah). Waxay xisaabisaa hal furitaan qaate kasta. Hawlgalka emailMarketingOpenPixel. Ka socda kaaliyaha AI: bog ay qaatayaashaadu ka furaan iimaylka (pixel-ka la-socodka furitaanka).
• GET /v1/public/email-marketing/u/{token} — Xiriirinta joojinta rukummada ee cagta hoose (ma jiro gelid). Hawlgalka emailMarketingUnsubscribePage. Ka socda kaaliyaha AI: bog ay qaatayaashaadu ka furaan iimaylka (bogga joojinta rukummada).
• POST /v1/public/email-marketing/u/{token} — RFC 8058 is-ka-saarista hal-guji ah (iyo badhanka bogga ee "wax walba jooji"). Hawlgalka emailMarketingUnsubscribeOneClick. Ka socota caawiye AI: waxaa wacday nidaam kale (bixiye ama booqde), adiga ma aha (RFC 8058 is-ka-saarista hal-guji ah).
• GET /v1/public/email-marketing/warmup-u/{token} — Xidhiidhka is-ka-saarista ee iimaylka warm-up-ka ee kooxda suuqgeynta (gelitaan la'aan). Hawlgalka emailMarketingWarmupUnsubscribePage. Ka socota caawiye AI: bog ay dadka qaataha ahi ka furaan iimayl (bogga is-ka-saarista warm-up-ka).
• POST /v1/public/email-marketing/warmup-u/{token} — RFC 8058 is-ka-saarista hal-guji ah ee iimaylka warm-up-ka. Hawlgalka emailMarketingWarmupUnsubscribeOneClick. Ka socota caawiye AI: waxaa wacday nidaam kale (bixiye ama booqde), adiga ma aha (is-ka-saarista hal-guji ah ee warm-up-ka).
• POST /v1/webhooks/campaign-events — Qaadashada dhacdo gaadhsiin oo saxeexan oo ka timid bixiyaha iimaylka. Hawlgalka receiveCampaignDeliveryWebhook. Ka socota caawiye AI: waxaa wacday nidaam kale (bixiye ama booqde), adiga ma aha (webhook-ka gaadhsiinta ESP ee saxeexan).
• POST /v1/webhooks/campaigns/telnyx — Jawaabaha SMS-ka ee soo galaya (STOP / START) ee ka socda iibiyaha SMS-keena. Hawlgalka receiveCampaignsTelnyxInbound. Ka socota caawiye AI: waxaa wacday nidaam kale (bixiye ama booqde), adiga ma aha (webhook-ka soo galaya ee Telnyx ee saxeexan).
• POST /v1/webhooks/email-marketing/{connection_id} — Dhacdooyinka gaarsiinta ee bixiyaha iimaylka ee macmiilka laftiisa ee hal xiriir diris ah. Hawlgalka receiveEmailMarketingProviderWebhook. Laga helo caawiyaha AI: waxa soo wacay nidaam kale (bixiye ama booqde), adiga ma ahan (webhook-ka bixiye-dire saxiixan).

Qulqullada

• GET /v1/email-marketing/flows — Qulqullada iimaylka (soo-dhaweyn, drip, taariikh sannadle ah), hal bog keyset ah. Hawlgalka listEmailMarketingFlows. Oggolaanshaha la hubiyay: email_marketing.view. Laga helo caawiyaha AI: haa, iyada oo loo marayo MCP-ga.
• POST /v1/email-marketing/flows — Samee qulqul (wuxuu ku bilaabmayaa qabyo ahaan). Hawlgalka createEmailMarketingFlow. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Laga helo caawiyaha AI: haa, iyada oo loo marayo MCP-ga.
• DELETE /v1/email-marketing/flows/{flow_id} — Tirtir qulqul iyo diiwaangelintiisa (dirisyadiisii baxay way harayaan, sida ololayaal ahaan). Hawlgalka deleteEmailMarketingFlow. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Laga helo caawiyaha AI: haa, iyada oo loo marayo MCP-ga.
• GET /v1/email-marketing/flows/{flow_id} — Hal qulqul oo leh tallaabooyinkiisa iyo warbixintiisa (diiwaangashan, socda, dirisyada iyo qaateyaasha tallaabo kasta). Hawlgalka getEmailMarketingFlow. Oggolaanshaha la hubiyay: email_marketing.view. Laga helo caawiyaha AI: haa, iyada oo loo marayo MCP-ga.
• PATCH /v1/email-marketing/flows/{flow_id} — Wax ka beddel socodka; steps, marka la bixiyo, waxay beddeleysaa dhammaan isku xigxiga. Hawlgalka updateEmailMarketingFlow. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka socota kaaliyaha AI: haa, iyada oo loo marayo MCP.
• POST /v1/email-marketing/flows/{flow_id}/activate — Daar socodka; kaliya dadka liiska ku soo biira hadda wixii ka dambeeya ayaa la diiwaangeliyaa. Hawlgalka activateEmailMarketingFlow. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka socota kaaliyaha AI: haa, iyada oo loo marayo MCP.
• POST /v1/email-marketing/flows/{flow_id}/pause — Haki socodka; tallaabooyinka la gaaray way sugayaan lamana dirayo qof cusub ilaa dib loo shido. Hawlgalka pauseEmailMarketingFlow. Oggolaanshaha la hubiyay: email_marketing.manage, email_marketing.view. Ka socota kaaliyaha AI: haa, iyada oo loo marayo MCP.