Zinn® Campaigns API da MCP: jagoran mai haɓakawa

Duk abin da za ku iya yi a Zinn® Campaigns a kan allon sarrafawa za ku iya yinsa ta hanyar API, kuma mafi yawancinsa daga mataimakin AI da aka haɗa da asusunku ta hanyar MCP. Wannan jagorar ta ƙunshi shiga ciki, izini, cikakken misali ta hanyoyi biyu, iyaka, kurakurai da kowane ɗayan ayyukan Campaigns guda 89. Jerin ayyukan da ke ƙasa an samar da shi ne daga ƙayyadaddun API ɗinmu, don haka koyaushe yana dacewa da abin da API ke yi. Kowane fanni na kowane aiki yana cikin bayanin API a zinndigital.com/developers/api/zinn-campaigns.

Shiga ciki

• Mabuɗan API. Ƙirƙiri maɓalli a allon sarrafawa a ƙarƙashin Saituna → Mabuɗan API sannan ku aika shi a matsayin Authorization: Bearer zdk_live_… (maɓallin zdk_test_… yana aiki a yanayin sandbox). Ba wa maɓallin izinin Campaigns da yake buƙata kawai ba tare da ƙari ba.
• Mataimakan AI (MCP). Haɗa Claude, ChatGPT, Cursor ko kowane abokin ciniki na MCP zuwa https://api.zinndigital.com/v1/mcp, ko dai ta hanyar shiga daga manhajar ko kuma da alamar haɗi (zmcp_live_…). Duba Haɗa Claude, Cursor ko ChatGPT zuwa asusunku. A allon amincewa, yi alama a izinin Zinn® Campaigns.
• Izini. email_marketing.view yana karanta kamfen, jerori, lambobin sadarwa, fom, masu aikawa, saitunan SMS da rahotanni; email_marketing.manage yana ƙirƙira da kuma sauya su. Kamfen ɗin da kuke aikawa ta hanyar sabis ɗin imel ɗinku na kanku suna amfani da campaigns.view da campaigns.manage.
• Masu sake sayarwa. Shigar da org_id don gudanar da aiki a ɗaya daga cikin ƙungiyoyin abokan cinikin ku. Bar shi a waje lokacin da maɓallinku ko haɗinku ya shafi ƙungiya ɗaya kacal.

Misali: ƙirƙiri daftarin kamfen tare da 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"
}'

Amsar ita ce 201 tare da daftarin. Gwada shi da POST /v1/email-marketing/campaigns/{campaign_id}/test, duba shi da GET /v1/email-marketing/campaigns/{campaign_id}/lint, sannan aika shi da POST /v1/email-marketing/campaigns/{campaign_id}/send.

Misali: daftari iri ɗaya daga mataimakin AI

Tambayi mataimakin ku a cikin kalmomi bayyanannu, misali "tsara imel ɗin Zinn® Campaigns mai suna Spring sale tare da batun 'Our spring sale starts today'". A bayan fage yana gano aikin tare da api_operations_search, yana karanta sigoginsa tare da api_operation_get, kuma yana gudanar da shi tare da 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"
      }
    }
  }
}

Abin da mataimaki ba zai yi ba. Duk wani abu da ke aikawa ga masu karɓarku ko kashe kuɗi ko izini — aikawa da yaƙin neman zaɓe, aika saƙonnin SMS ko WhatsApp, rubutu da lamunin AI, yin rajista don saƙon tes a US — an ƙi shi ga mataimaki, don haka umarnin da ba a fahimta ba ba zai taɓa isa ga abokan cinikin ku ba. Mataimakin yana shirya daftarin; ku danna Aika a cikin allon sarrafawa ko ku kira API ɗin da kanku. Asirin kamar kalmar sirri ta SMTP kuma ba a taɓa ƙetare su ta wurin mataimaki ba: shigar da su a cikin allon sarrafawa.

Iyakoki

• Bukatu 1,200 a minti ɗaya ga kowane mutum ko maɓallin API, da bukatu 6,000 a minti ɗaya ga kowace ƙungiya. Mafi tsauri a cikin biyun ya shafi.
• Bukatu 600 a minti ɗaya ga kowace haɗin MCP.
• A kan iyaka, amsar ita ce 429 tare da kanun Retry-After: jira waɗannan daƙiƙa da yawa.
• Ƙara membobin jeri yana ɗaukar aƙalla adireshi 1,000 a buƙata; izinin tuntuɓar ku da imel na tsarin ku ya shafi duk abin da kuke yi ta hanyar API.

Kurakurai

Kowane kuskure yana da siffa iri ɗaya:

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

code ba ya taɓa canzawa don matsala iri ɗaya, don haka gwada shi maimakon message. Ambaci request_id lokacin da kuka tuntuɓi sashen tallafi. Amsoshin da za ku fuskanta: 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 CONFLICT, 422 UNPROCESSABLE_ENTITY, 429 TOO_MANY_REQUESTS. 403 na nufin maɓalli ko haɗin ba shi da izinin da jerin da ke ƙasa ya ambata; 404 yana kuma shafar wani abu a cikin ƙungiyar da ba za ku iya gani ba; 422 yana lissafin kowane fanni da ba daidai ba a cikin details; bayan 429, jira adadin daƙiƙoƙin da ke cikin kanun Retry-After.

Webhooks

Sakamakon isarwa yana shigowa cikin Zinn® Campaigns daga mai ba da sabis ɗin da ke aika imel ɗinku:

• Tare da naku mai ba da sabis ɗin (misali Resend), adana asirin sa hannun webhook ɗinsa a kan haɗin aikawa a cikin allon sarrafawa (Kamfen-kamfen → Aikawa). Za ku sami webhook_url; nuna abubuwan da suka faru na delivered, bounced da complained na mai ba da sabis ɗin zuwa gare shi. Bouncing ko ƙarar spam yana cire adireshin nan take daga aikawa na gaba.
• Tare da aikawar Zinn®, babu abin da za a saita.

Karanta sakamakon tare da ayyukan rahoton (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).

Kowane aikin Kamfen-kamfen

Taƙaitaccen bayani

• GET /v1/email-marketing — Taƙaitaccen bayanin Zinn® Campaigns don ƙungiya ɗaya. Aikin getEmailMarketingOverview. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.

Kamfen-kamfen ɗin imel

• GET /v1/email-marketing/campaigns — Yaƙe-yaƙen e-mail, sababbi a farko, shafi ɗaya na keyset. Aiki listEmailMarketingCampaigns. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• POST /v1/email-marketing/campaigns — Ƙirƙiri daftarin yaƙin neman zaɓe na e-mail. Aiki createEmailMarketingCampaign. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• GET /v1/email-marketing/campaigns/{campaign_id} — Yaƙin neman zaɓe na e-mail guda ɗaya. Aiki getEmailMarketingCampaign. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• PATCH /v1/email-marketing/campaigns/{campaign_id} — Gyara daftarin aiki (ko yaƙin neman zaɓe da aka ƙi, wanda ke komawa zuwa daftarin aiki). Aiki updateEmailMarketingCampaign. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/lint — Bincika rubutun yaƙin neman zaɓe don matsalolin isarwa kafin a aika shi. Aiki lintEmailMarketingCampaign. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/report — Lambobin yaƙin neman zaɓe. Aiki getEmailMarketingCampaignReport. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/send — Fara aika kamfen zuwa jerinsa. Aiki sendEmailMarketingCampaign. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: API da dashboard kawai: yana kashe kuɗi ko izini, don haka mutum ne yake danna shi (yana aikawa ga ainihin masu karɓa kuma yana kashe izini).
• POST /v1/email-marketing/campaigns/{campaign_id}/test — Aika kwafin gwaji guda ɗaya yanzu ga memba na ƙungiyar. Aiki testEmailMarketingCampaign. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: eh, ta hanyar MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/translate — Fassara kamfen zuwa kowane yaren lambar sadarwa da ya ɓace ko ya tsufa. Aiki translateEmailMarketingCampaign. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: eh, ta hanyar MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/translations — Kowane yaren lambar sadarwa na jerin kamfen da ko fassararsa tana kan lokaci. Aiki listEmailMarketingCampaignTranslations. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: eh, ta hanyar MCP.

Rubutu tare da AI

• POST /v1/email-marketing/ai/write — Rubuta daftarin imel ɗin kamfen daga taƙaitaccen bayani tare da Zinn® AI. Aiki writeEmailMarketingCampaignWithAi. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: API da allon sarrafawa kawai: yana kashe kuɗi ko alawus, don haka mutum ne ke danna shi (rubutun AI yana kashe kiredit ɗin AI).

Kayan aikin alama

• GET /v1/email-marketing/brand-kit — Kayan aikin alama na ƙungiyar (suna, tambari, launuka, rubutu, murya). Aiki getEmailMarketingBrandKit. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: eh, ta hanyar MCP.
• PUT /v1/email-marketing/brand-kit — Gyara kayan aikin alama. Aiki updateEmailMarketingBrandKit. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: eh, ta hanyar MCP.
• POST /v1/email-marketing/brand-kit/read — Karanta kayan aikin alama daga gidan yanar gizon ƙungiyar. Aiki readEmailMarketingBrandKit. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: eh, ta hanyar MCP.

Lambobin sadarwa da saƙonnin lokaci ɗaya

• GET /v1/email-marketing/contacts — Lambobin sadarwa na ƙungiyar, shafi ɗaya na keyset a lokaci guda. Aiki listEmailMarketingContacts. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: eh, ta hanyar MCP.
• POST /v1/email-marketing/contacts/{contact_id}/messages — Aika saƙon SMS ɗaya zuwa ga lamba ɗaya, wanda aka biya daga ma'aunin kuɗin Zinn®. Aiki sendEmailMarketingMessage. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: API da dashboard kawai: yana kashe kuɗi ko izinin amfani, saboda haka mutum ne yake danna shi (saƙo na lokaci ɗaya zuwa ga lamba yana kashe izinin amfani).
• GET /v1/email-marketing/messages — Saƙonnin SMS da WhatsApp waɗanda ƙungiyar ta aika, sababbi a farko, shafi ɗaya na keyset. Aiki listEmailMarketingMessages. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: eh, ta hanyar MCP.

Jerori

• GET /v1/email-marketing/lists — Jeraren aika saƙo na ƙungiyar tare da adadin waɗanda suka yi rajista / suka soke rajista. Aiki listEmailMarketingLists. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• POST /v1/email-marketing/lists — Ƙirƙiri jerin aika saƙo (ko dawo da wanda ke da wannan sunan). Aiki createEmailMarketingList. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• POST /v1/email-marketing/lists/{list_id}/members — Ƙara lambobin sadarwa zuwa jerin ta adireshin imel (aƙalla 1,000 a kowace buƙata). Aiki addEmailMarketingListMembers. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.

Shigo da abubuwa

• GET /v1/email-marketing/imports — Shigo da lambobin sadarwa da suka gabata, sababbi a farko, shafi ɗaya na keyset a lokaci guda. Aiki listEmailMarketingImports. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• POST /v1/email-marketing/imports — Shigo da gungu ɗaya na lambobin sadarwa tare da tabbacin yardarsa. Aiki createEmailMarketingImport. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.

Fom ɗin yin rajista

• GET /v1/email-marketing/forms — Fom-fom na yin rajista (double opt-in), sabbi a farko, shafi ɗaya na keyset. Aiki listEmailMarketingForms. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• POST /v1/email-marketing/forms — Ƙirƙiri fom ɗin yin rajista wanda ke ƙara mutanen da aka tabbatar zuwa lissafi ɗaya. Aiki createEmailMarketingForm. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• DELETE /v1/email-marketing/forms/{form_id} — Share fom ɗin yin rajista (mutanen da aka riga aka tabbatar suna ci gaba da kasancewa a cikin lissafin). Aiki deleteEmailMarketingForm. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• PATCH /v1/email-marketing/forms/{form_id} — Canza fom ɗin yin rajista (kalmomi, lissafi, tura wani wuri, kunna ko kashe). Aiki updateEmailMarketingForm. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.

Haɗe-haɗen aikawa

• GET /v1/email-marketing/senders — Haɗin aika saƙonni na ƙungiyar. Aiki listEmailMarketingSenders. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• POST /v1/email-marketing/senders — Haɗa mai aika yaƙin neman zaɓe (aika Zinn®, ko uwar garken SMTP na abokin ciniki kansa). Aiki createEmailMarketingSender. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: API da allon sarrafawa kawai: yana ɗauke da sirrin da bai kamata ya taɓa isa ga samfurin AI ba (jikin saƙon shi ne kalmar sirri ta SMTP).
• DELETE /v1/email-marketing/senders/{sender_id} — Cire haɗin aika saƙo da kalmar sirrinsa da aka ajiye. Aiki deleteEmailMarketingSender. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• POST /v1/email-marketing/senders/{sender_id}/verify — Tabbatar cewa haɗin aika saƙo yana aiki, ba tare da an aika komai ba. Aiki verifyEmailMarketingSender. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• PUT /v1/email-marketing/senders/{sender_id}/webhook — Ajiye sirrin sa hannu na webhook na mai samar da imel ɗinku don wannan haɗin. Aiki setEmailMarketingSenderWebhook. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: wani tsarin ne ke kiransa (mai samarwa ko baƙo), ba ku ba (yana adana sirrin webhook na mai samarwa).

SMS da WhatsApp

• GET /v1/email-marketing/sms — Abin da allon SMS ke buƙata — buɗe?, an dakatar?, ma'aunin kuɗi da farashoshi. Aiki getEmailMarketingSms. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• GET /v1/email-marketing/sms/campaigns — Yaƙin neman zaɓe na SMS mai yawa, sababbi da farko, shafi ɗaya na keyset. Aiki listSmsMarketingCampaigns. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• POST /v1/email-marketing/sms/campaigns — Ƙirƙiri daftarin SMS zuwa lissafi. Aiki createSmsMarketingCampaign. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id} — Yaƙin neman zaɓe na SMS mai yawa guda ɗaya. Aiki getSmsMarketingCampaign. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — Gyara daftari (ko yaƙin neman zaɓe da aka ƙi, wanda ke komawa zuwa daftari). Aiki updateSmsMarketingCampaign. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — Lambobin yaƙin neman zaɓe na SMS mai yawa. Aiki getSmsMarketingCampaignReport. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — Fara aika SMS ga kowa da ke cikin jerinsa wanda ya amince da SMS — ko kuma ci gaba da wanda aka dakatar saboda kiredit. Aiki sendSmsMarketingCampaign. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: API da allon sarrafawa kawai: yana kashe kudi ko izinin amfani, saboda haka mutum ne ke danna shi (yana aika sakonnin SMS/WhatsApp da ake biya).
• GET /v1/email-marketing/sms/registrations/us — Rajistar US 10DLC ta wannan kungiya, da kuma kudin daya. Aiki getEmailMarketingUsRegistration. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: eh, ta hanyar MCP.
• POST /v1/email-marketing/sms/registrations/us — Mika alamar kasuwanci da yakin neman zabe na wannan kungiya don US 10DLC (ana caji yayin mikawa). Aiki submitEmailMarketingUsRegistration. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: API da allon sarrafawa kawai: yana kashe kudi ko izinin amfani, saboda haka mutum ne ke danna shi (rajistar US 10DLC tana dauke da kudaden kamfanin sadarwa).

Yakin neman zabe ta hanyar sabis din imel dinku na kanku (samfura, bangarori, dannewa)

• GET /v1/campaigns — Yakin neman zaben kungiyar. Aiki listCampaigns. Daga mataimakin AI: eh, ta hanyar MCP.
• POST /v1/campaigns — Kirkiri yakin neman zabe daga samfuri da masu sauraro. Aiki createCampaign. Daga mataimakin AI: eh, ta hanyar MCP.
• DELETE /v1/campaigns/esp — Cire haɗin asusun mai bada sabis ɗin sannan ka goge maɓallin da aka ajiye. Aiki disconnectEsp. Daga mataimakin AI: API da dashboard kaɗai: yana ɗauke da wani sirri wanda bai kamata ya taɓa isa ga samfurin AI ba (yana lalata maɓallin ESP da aka ajiye).
• GET /v1/campaigns/esp — Asirin asusun mai ba da imel na ƙungiyar kanta. Aiki getEspConnection. Daga mataimakin AI: eh, ta hanyar MCP.
• POST /v1/campaigns/esp — Haɗa asusun mai ba da imel. Aiki connectEsp. Daga mataimakin AI: API da dashboard kaɗai: yana ɗauke da wani sirri wanda bai kamata ya taɓa isa ga samfurin AI ba (bayanin da ke ciki shine maɓallin ESP API).
• POST /v1/campaigns/esp/verify — Tabbatar da cewa asusun mai bada sabis yana aiki kuma karanta yankunan da aka tantance. Aiki verifyEspConnection. Daga mataimakin AI: API da dashboard kaɗai: yana ɗauke da wani sirri wanda bai kamata ya taɓa isa ga samfurin AI ba (yana sake bincika maɓallin ESP da aka ajiye).
• POST /v1/campaigns/preview — Render samfuri tare da misalan ƙimomi. Aiki previewCampaignTemplate. Daga mataimakin AI: eh, ta hanyar MCP.
• GET /v1/campaigns/segments — Rukunin masu sauraronku da kuka adana. Aiki listCampaignSegments. Izinin da aka duba: campaigns.view. Daga mataimakin AI: eh, ta hanyar MCP.
• POST /v1/campaigns/segments — Ajiye sabon ɓangaren masu sauraro. Aiki createCampaignSegment. Izinin da aka duba: campaigns.manage. Daga mataimakin AI: eh, ta hanyar MCP.
• GET /v1/campaigns/segments/fields — Kalmomin tace bayanai, jerin ƙimominsu da kuma lambobin sihiri. Aiki getCampaignSegmentFields. Izinin da aka bincika: campaigns.view. Daga mataimakin AI: eh, ta hanyar MCP.
• POST /v1/campaigns/segments/preview — Yawan mutanen da wannan yake isa gare su, ko su wane ne, da kuma waɗanda aka cire. Aiki previewCampaignSegment. Izinin da aka bincika: campaigns.view. Daga mataimakin AI: eh, ta hanyar MCP.
• DELETE /v1/campaigns/segments/{segmentId} — Adana wani sashe a rumbun adana bayanai. Aiki archiveCampaignSegment. Izinin da aka bincika: campaigns.manage. Daga mataimakin AI: eh, ta hanyar MCP.
• GET /v1/campaigns/segments/{segmentId} — Sashe guda ɗaya da aka adana. Aiki getCampaignSegment. Izinin da aka bincika: campaigns.view. Daga mataimakin AI: eh, ta hanyar MCP.
• PATCH /v1/campaigns/segments/{segmentId} — Sake sanya wa sashe suna ko sauya matatansa. Aiki updateCampaignSegment. Izinin da aka bincika: campaigns.manage. Daga mataimakin AI: eh, ta hanyar MCP.
• GET /v1/campaigns/suppressions — Adireshin da bai kamata su karɓi tallan kasuwanci ba. Aiki listCampaignSuppressions. Izinin da aka bincika: campaigns.view. Daga mataimakin AI: eh, ta hanyar MCP.
• POST /v1/campaigns/suppressions — Ƙara adireshi zuwa jerin waɗanda aka hana. Aiki createCampaignSuppression. Izinin da aka bincika: campaigns.manage. Daga mataimakin AI: eh, ta hanyar MCP.
• GET /v1/campaigns/tags — Jerin magic-tag da mawallafin kamfen ke bayarwa. Aiki listCampaignTags. Daga mataimakin AI: e, ta hanyar MCP.
• GET /v1/campaigns/templates — Samfuran kamfen na ƙungiyar. Aiki listCampaignTemplates. Daga mataimakin AI: e, ta hanyar MCP.
• POST /v1/campaigns/templates — Ƙirƙiri samfurin kamfen. Aiki createCampaignTemplate. Daga mataimakin AI: e, ta hanyar MCP.
• DELETE /v1/campaigns/templates/{templateId} — Adana samfuri a rumbun ajiya sannan a janye tushen fassararsa. Aiki archiveCampaignTemplate. Daga mataimakin AI: e, ta hanyar MCP.
• GET /v1/campaigns/templates/{templateId} — Samfurin kamfen guda ɗaya. Aiki getCampaignTemplate. Daga mataimakin AI: e, ta hanyar MCP.
• PUT /v1/campaigns/templates/{templateId} — Gyara samfurin kamfen. Aiki updateCampaignTemplate. Daga mataimakin AI: e, ta hanyar MCP.
• POST /v1/campaigns/unsubscribe — Fita daga jerin tallace-tallace. Ba a buƙatar asusu. Aiki unsubscribeFromCampaigns. Daga mataimakin AI: API da dashboard kaɗai: yana ɗauke da sirrin da bai kamata ya taɓa isa ga samfurin AI ba (yana karɓar sa hannun cire rijista na mai karɓa).
• DELETE /v1/campaigns/{campaignId} — Goge kamfen sannan a janye layukan isarwarsa. Aiki deleteCampaign. Daga mataimakin AI: API da dashboard kaɗai: yana buƙatar izinin da ba a ba wa hanyoyin haɗin AI ba (goge kamfen ɗin ESP yana buƙatar campaigns.send).
• GET /v1/campaigns/{campaignId} — Gangami guda ɗaya da rahoton isarwarsa. Aiki getCampaign. Daga mataimakin AI: i, ta hanyar MCP.
• POST /v1/campaigns/{campaignId}/control — Dakatar, ci gaba ko soke aikin aikawa da ke gudana. Aiki controlCampaign. Daga mataimakin AI: API da dashboard kaɗai: yana kashe kuɗi ko izini, don haka mutum ke danna shi (yana dakatarwa/ci gaba da aikawa kai tsaye).
• POST /v1/campaigns/{campaignId}/send — Fara aikawa mai dorewa. Aiki sendCampaign. Daga mataimakin AI: API da dashboard kaɗai: yana kashe kuɗi ko izini, don haka mutum ke danna shi (yana aika gangamin ESP zuwa ga ainihin masu karɓa).
• POST /v1/campaigns/{campaignId}/test — Aika ainihin saƙo guda ɗaya a tashar da ainihin gangamin zai yi amfani da ita. Aiki testSendCampaign. Daga mataimakin AI: API da dashboard kaɗai: yana buƙatar izinin da ba a bayar ga haɗin AI ba (gwajin aikawa na ESP yana buƙatar campaigns.send).

Shafukan jama'a da webhooks masu shigowa

• GET /v1/public/email-marketing/c/{token} — Ma'aunin danna linzami. Yana ɗaukar dannawa ɗaya ga kowane mai karɓa kuma yana tura zuwa ainihin hanyar haɗin yanar gizo. Aiki emailMarketingClick. Daga mataimakin AI: shafin da masu karɓarku ke buɗewa daga imel (turawar bin diddigin dannawa).
• GET /v1/public/email-marketing/f/{public_id} — Shafin da aka karɓi baƙuncin fom ɗin yin rajista (ba buƙatar shiga). Aiki emailMarketingFormPage. Daga mataimakin AI: shafin da masu karɓarku ke buɗewa daga imel (shafin jama'a na fom ɗin yin rajista).
• POST /v1/public/email-marketing/f/{public_id} — Aika fom ɗin yin rajista (shafi mai masauki, da aka saka ko JSON). Aiki emailMarketingFormSubmit. Daga mataimakin AI: wani tsarin ne ke kiransa (mai ba da sabis ko mai ziyara), ba ku ba (mai ziyara yana aika fom ɗin rajista).
• GET /v1/public/email-marketing/fc — Shafin tabbatar da double opt-in (babu shiga). Aiki emailMarketingFormConfirmPage. Daga mataimakin AI: shafin da masu karɓarku ke buɗewa daga imel (shafin tabbatar da double opt-in).
• POST /v1/public/email-marketing/fc — Tabbatar da rajista (yana ƙara mutumin a jerin tare da rikodin yarda). Aiki emailMarketingFormConfirm. Daga mataimakin AI: wani tsarin ne ke kiransa (mai ba da sabis ko mai ziyara), ba ku ba (mai ziyara yana tabbatar da double opt-in).
• GET /v1/public/email-marketing/o/{token} — Hoton bibiyar buɗewa (GIF na 1x1). Yana ƙidaya buɗewa ɗaya ga kowane mai karɓa. Aiki emailMarketingOpenPixel. Daga mataimakin AI: shafin da masu karɓarku ke buɗewa daga imel (pixel na bibiyar buɗewa).
• GET /v1/public/email-marketing/u/{token} — Mahadar cire rajista ta ƙasan shafi (babu shiga). Aiki emailMarketingUnsubscribePage. Daga mataimakin AI: shafin da masu karɓarku ke buɗewa daga imel (shafin cire rajista).
• POST /v1/public/email-marketing/u/{token} — Cire rajista da dannawa ɗaya na RFC 8058 (da maɓallin "dakatar da komai" na shafin). Aiki emailMarketingUnsubscribeOneClick. Daga mataimakin AI: wani tsarin daban ne ya kira shi (mai bayarwa ko baƙo), ba kai ba (cire rajista da dannawa ɗaya na RFC 8058).
• GET /v1/public/email-marketing/warmup-u/{token} — Hanyar cire rajista ta saƙon imel na ɗumamar rukunin tallace-tallace (ba buƙatar shiga). Aiki emailMarketingWarmupUnsubscribePage. Daga mataimakin AI: shafin da waɗanda kake tura wa saƙo ke buɗewa daga imel (shafin cire rajista na ɗumama).
• POST /v1/public/email-marketing/warmup-u/{token} — Cire rajista da dannawa ɗaya na RFC 8058 daga saƙon imel na ɗumama. Aiki emailMarketingWarmupUnsubscribeOneClick. Daga mataimakin AI: wani tsarin daban ne ya kira shi (mai bayarwa ko baƙo), ba kai ba (cire rajista da dannawa ɗaya na ɗumama).
• POST /v1/webhooks/campaign-events — Shigar da ingantaccen lamarin isarwa da aka sa wa hannu daga mai samar da e-mail. Aiki receiveCampaignDeliveryWebhook. Daga mataimakin AI: wani tsarin daban ne ya kira shi (mai bayarwa ko baƙo), ba kai ba (sa hannun ESP delivery webhook).
• POST /v1/webhooks/campaigns/telnyx — Amsoshin SMS masu shigowa (STOP / START) daga mai sayar mana da SMS. Aiki receiveCampaignsTelnyxInbound. Daga mataimakin AI: wani tsarin daban ne ya kira shi (mai bayarwa ko baƙo), ba kai ba (sa hannun Telnyx inbound webhook).
• POST /v1/webhooks/email-marketing/{connection_id} — Abubuwan da suka shafi isar da saƙonni na mai ba da sabis na imel na abokin ciniki don haɗin aikawa guda ɗaya. Aiki receiveEmailMarketingProviderWebhook. Daga mataimakin AI: wani tsarin ne ke kiransa (mai ba da sabis ko baƙo), ba ku ba (sa hannun mai aikawa da mai ba da sabis na webhook).

Gudana

• GET /v1/email-marketing/flows — Hanyoyin kwararar imel (maraba, drip, ranar shekara-shekara), shafi ɗaya na keyset. Aiki listEmailMarketingFlows. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• POST /v1/email-marketing/flows — Ƙirƙiri gudanarwa (yana farawa azaman daftari). Aiki createEmailMarketingFlow. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• DELETE /v1/email-marketing/flows/{flow_id} — Share kwarara da rajistarsa (aikace-aikacen da aka aiko suna nan, azaman yakin neman zaɓe). Aiki deleteEmailMarketingFlow. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• GET /v1/email-marketing/flows/{flow_id} — Gudana ɗaya tare da matakan sa da rahotonsa (an yi rajista, yana kan aiki, gudu da masu karɓa a kowane mataki). Aiki getEmailMarketingFlow. Izinin da aka bincika: email_marketing.view. Daga mataimakin AI: e, ta hanyar MCP.
• PATCH /v1/email-marketing/flows/{flow_id} — Canza flow; steps, idan an bayar, yana maye gurbin duka jeri. Aiki updateEmailMarketingFlow. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: eh, ta hanyar MCP.
• POST /v1/email-marketing/flows/{flow_id}/activate — Kunna flow; mutanen da suka shiga jerin daga yanzu ne kawai za a yi wa rajista. Aiki activateEmailMarketingFlow. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: eh, ta hanyar MCP.
• POST /v1/email-marketing/flows/{flow_id}/pause — Dakatar da flow; matakan da suka dace za su jira kuma babu wani sabon mutum da za a aika wa saƙo har sai an sake kunna shi. Aiki pauseEmailMarketingFlow. Izinin da aka bincika: email_marketing.manage, email_marketing.view. Daga mataimakin AI: eh, ta hanyar MCP.