Zinn® Campaigns API at MCP: gabay para sa developer

Lahat ng maaari ninyong gawin sa Zinn® Campaigns sa dashboard ay maaari niyo ring gawin sa pamamagitan ng API, at karamihan dito ay mula sa isang AI assistant na nakakonekta sa inyong account sa pamamagitan ng MCP. Sinasaklaw ng gabay na ito ang pag-sign in, ang mga pahintulot, isang halimbawang ginawa sa parehong paraan, ang mga limitasyon, ang mga error, at bawat isa sa 89 na operasyon ng Campaigns. Ang listahan ng operasyon sa ibaba ay nabuo mula sa aming detalye ng API, kaya palagi itong tumutugma sa ginagawa ng API. Bawat field ng bawat operasyon ay nasa sanggunian ng API sa zinndigital.com/developers/api/zinn-campaigns.

Pag-sign in

• Mga API key. Gumawa ng key sa dashboard sa ilalim ng Mga Setting → Mga API key at ipadala ito bilang Authorization: Bearer zdk_live_… (gumagana ang zdk_test_… na key sa sandbox mode). Ibigay sa key ang mga pahintulot sa Campaigns na kailangan nito at wala nang iba pa.
• Mga AI assistant (MCP). Ikonekta ang Claude, ChatGPT, Cursor o anumang MCP client sa https://api.zinndigital.com/v1/mcp, sa pamamagitan man ng pag-sign in mula sa app o gamit ang isang token ng koneksyon (zmcp_live_…). Tingnan ang Pagkonekta ng Claude, Cursor o ChatGPT sa iyong account. Sa screen ng pahintulot, lagyan ng tsek ang mga pahintulot ng Zinn® Campaigns.
• Mga Pahintulot. Binabasa ng email_marketing.view ang mga campaign, listahan, contact, form, nagpadala, setting ng SMS at ulat; ginagawa at binabago naman ang mga ito ng email_marketing.manage. Ang mga campaign na ipinapadala ninyo sa pamamagitan ng sarili ninyong serbisyo sa email ay gumagamit ng campaigns.view at campaigns.manage.
• Mga Reseller. Ipasa ang org_id upang kumilos sa isa sa mga organisasyon ng inyong kliyente. Huwag na itong isama kapag ang inyong key o koneksyon ay para lang sa eksaktong isang organisasyon.

Halimbawa: gumawa ng draft campaign gamit ang 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"
}'

Ang sagot ay 201 kasama ang draft. I-test ito gamit ang POST /v1/email-marketing/campaigns/{campaign_id}/test, suriin ito gamit ang GET /v1/email-marketing/campaigns/{campaign_id}/lint, at ipadala ito gamit ang POST /v1/email-marketing/campaigns/{campaign_id}/send.

Halimbawa: ang parehong draft mula sa isang AI assistant

Magtanong sa iyong assistant sa mga simpleng salita, halimbawa "draft a Zinn® Campaigns email called Spring sale with the subject 'Our spring sale starts today'". Sa likod ng mga eksena, mahahanap nito ang operasyon gamit ang api_operations_search, babasahin ang mga parameter nito gamit ang api_operation_get, at patatakbuhin ito gamit ang 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"
      }
    }
  }
}

Ang hindi gagawin ng isang assistant. Anumang bagay na nagpapadala sa iyong mga tatanggap o gumagastos ng pera o allowance — pagpapadala ng campaign, pagpapadala ng mga mensaheng SMS o WhatsApp, pagsusulat gamit ang mga AI credit, pagpaparehistro para sa US texting — ay hindi pinapahintulutan sa isang assistant, kaya hindi kailanman makakarating sa iyong mga customer ang isang maling naunawaang tagubilin. Inihahanda ng assistant ang draft; ikaw ang pipindot sa Ipadala sa dashboard o tatawag mismo sa API. Ang mga lihim tulad ng isang password sa SMTP ay hindi rin kailanman ipinapasa sa pamamagitan ng isang assistant: ilagay ang mga ito sa dashboard.

Mga Limitasyon

• 1,200 kahilingan bawat minuto para sa bawat tao o API key, at 6,000 kahilingan bawat minuto para sa bawat organisasyon. Ang mas mahigpit sa dalawa ang siyang masusunod.
• 600 kahilingan bawat minuto para sa bawat koneksyon sa MCP.
• Kapag lumampas sa limitasyon, ang sagot ay 429 na may header na Retry-After: maghintay ng ganoong karaming segundo.
• Ang pagdaragdag ng mga miyembro sa listahan ay tumatanggap ng hindi hihigit sa 1,000 address bawat kahilingan; ang mga allowance sa contact at email ng iyong plano ay nalalapat sa lahat ng gagawin mo sa pamamagitan ng API.

Mga Error

Ang bawat error ay may parehong anyo:

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

code ay hindi kailanman nagbabago para sa parehong problema, kaya subukan ito sa halip na message. Banggitin ang request_id kapag nakipag-ugnayan ka sa suporta. Ang mga sagot na makakaharap mo: 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 CONFLICT, 422 UNPROCESSABLE_ENTITY, 429 TOO_MANY_REQUESTS. Ang 403 ay nangangahulugang kulang ang key o koneksyon sa isang pahintulot na pinangalanan sa listahan sa ibaba; sumasaklaw din ang 404 sa isang bagay sa isang organisasyon na hindi mo makita; ang 422 ay naglilista ng bawat maling field sa details; pagkatapos ng 429, maghintay ng bilang ng mga segundo sa header na Retry-After.

Mga Webhook

Ang mga resulta ng paghahatid ay pumapasok sa Zinn® Campaigns mula sa provider na nagpapadala ng iyong email:

• Gamit ang iyong sariling provider (halimbawa Resend), i-store ang webhook signing secret nito sa koneksyon sa pagpapadala sa dashboard (Mga Kampanya → Pagpapadala). Makakakuha ka ng webhook_url; ituro ang mga event na delivered, bounced, at complained ng provider dito. Ang isang bounce o reklamo sa spam ay agad na nag-aalis ng address mula sa mga pagpapadala sa hinaharap.
• Gamit ang pagpapadala ng Zinn®, walang kailangang i-set up.

Basahin ang mga resulta gamit ang mga operasyon ng ulat (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).

Bawat operasyon ng Mga Kampanya

Pangkalahatang-ideya

• GET /v1/email-marketing — Pangkalahatang-ideya ng Zinn® Campaigns para sa isang organisasyon. Operasyong getEmailMarketingOverview. Sinuring mga pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.

Mga kampanya sa email

• GET /v1/email-marketing/campaigns — Mga e-mail campaign, pinakabago muna, isang keyset page. Operasyon listEmailMarketingCampaigns. Sinuring mga pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/campaigns — Lumikha ng isang draft na e-mail campaign. Operasyon createEmailMarketingCampaign. Sinuring mga pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• GET /v1/email-marketing/campaigns/{campaign_id} — Isang e-mail campaign. Operasyon getEmailMarketingCampaign. Sinuring mga pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• PATCH /v1/email-marketing/campaigns/{campaign_id} — I-edit ang isang draft (o isang tinanggihang campaign, na babalik sa draft). Operasyon updateEmailMarketingCampaign. Sinuring mga pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/lint — Suriin ang teksto ng campaign para sa mga problema sa paghahatid bago ito ipadala. Operasyon lintEmailMarketingCampaign. Sinuring mga pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/report — Ang mga numero ng isang campaign. Operasyon getEmailMarketingCampaignReport. Sinuring mga pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/send — Simulan ang pagpapadala ng campaign sa listahan nito. Operasyong sendEmailMarketingCampaign. Mga pahintulot na sinuri: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: API at dashboard lamang: gumagastos ito ng pera o allowance, kaya tao ang pumipindot dito (nagpapadala sa mga totoong tatanggap at gumagastos ng allowance).
• POST /v1/email-marketing/campaigns/{campaign_id}/test — Magpadala ng isang pansubok na kopya ngayon sa isang miyembro ng organisasyon. Operasyong testEmailMarketingCampaign. Mga pahintulot na sinuri: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/translate — Isalin ang isang campaign sa bawat wika ng contact na nawawala o luma na. Operasyong translateEmailMarketingCampaign. Mga pahintulot na sinuri: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/translations — Bawat wika ng contact ng listahan ng campaign at kung napapanahon ang pagsasalin nito. Operasyong listEmailMarketingCampaignTranslations. Mga pahintulot na sinuri: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.

Pagsusulat gamit ang AI

• POST /v1/email-marketing/ai/write — Sumulat ng draft na campaign email mula sa isang maikling brief gamit ang Zinn® AI. Operasyong writeEmailMarketingCampaignWithAi. Mga sinuring pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: API at dashboard lamang: gumagastos ito ng pera o allowance, kaya tao ang pumipindot nito (ang pagsulat ng AI ay gumagastos ng mga credit ng AI).

Brand kit

• GET /v1/email-marketing/brand-kit — Ang brand kit ng organisasyon (pangalan, logo, mga kulay, font, boses). Operasyong getEmailMarketingBrandKit. Mga sinuring pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• PUT /v1/email-marketing/brand-kit — I-edit ang brand kit. Operasyong updateEmailMarketingBrandKit. Mga sinuring pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/brand-kit/read — Basahin ang brand kit mula sa website ng organisasyon. Operasyong readEmailMarketingBrandKit. Mga sinuring pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.

Mga contact at isahang mensahe

• GET /v1/email-marketing/contacts — Ang mga contact ng organisasyon, isang keyset page sa bawat pagkakataon. Operasyon listEmailMarketingContacts. Sinuring mga pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/contacts/{contact_id}/messages — Magpadala ng isang SMS sa isang contact, binayaran mula sa balanse ng credit sa Zinn®. Operasyon sendEmailMarketingMessage. Sinuring mga pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: API at dashboard lamang: gumagastos ito ng pera o allowance, kaya isang tao ang pumipindot dito (ang isang beses na mensahe sa isang contact ay gumagastos ng allowance).
• GET /v1/email-marketing/messages — Mga mensaheng SMS at WhatsApp na ipinadala ng organisasyon, pinakabago muna, isang keyset page. Operasyon listEmailMarketingMessages. Sinuring mga pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.

Mga Listahan

• GET /v1/email-marketing/lists — Ang mga mailing list ng organisasyon na may mga bilang ng naka-subscribe / nag-unsubscribe. Operasyon: listEmailMarketingLists. Mga pahintulot na sinuri: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/lists — Lumikha ng isang mailing list (o ibalik ang may ganoong pangalan). Operasyon: createEmailMarketingList. Mga pahintulot na sinuri: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/lists/{list_id}/members — Magdagdag ng mga contact sa isang listahan sa pamamagitan ng e-mail address (hanggang 1,000 bawat kahilingan). Operasyon: addEmailMarketingListMembers. Mga pahintulot na sinuri: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.

Mga Import

• GET /v1/email-marketing/imports — Mga nakaraang pag-import ng contact, pinakabago muna, isang keyset page sa bawat pagkakataon. Operasyon: listEmailMarketingImports. Mga pahintulot na sinuri: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/imports — Mag-import ng isang chunk ng mga contact kasama ang pagpapatunay ng pahintulot nito. Operasyon: createEmailMarketingImport. Mga pahintulot na sinuri: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.

Mga form ng pag-sign up

• GET /v1/email-marketing/forms — Mga sign-up form (double opt-in), pinakabago muna, isang keyset page. Operasyong listEmailMarketingForms. Sinuring mga pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/forms — Gumawa ng sign-up form na nagdaragdag ng mga kumpirmadong tao sa isang listahan. Operasyong createEmailMarketingForm. Sinuring mga pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• DELETE /v1/email-marketing/forms/{form_id} — Mag-delete ng sign-up form (mananatili sa listahan ang mga taong nakumpirma na). Operasyong deleteEmailMarketingForm. Sinuring mga pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• PATCH /v1/email-marketing/forms/{form_id} — Baguhin ang isang sign-up form (mga salita, listahan, pag-redirect, naka-on o naka-off). Operasyong updateEmailMarketingForm. Sinuring mga pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.

Mga koneksyon sa pagpapadala

• GET /v1/email-marketing/senders — Ang mga koneksyon sa pagpapadala ng organisasyon. Operasyon listEmailMarketingSenders. Mga sinuring pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/senders — Ikonekta ang isang nagpapadala ng kampanya (pagpapadala ng Zinn®, o sariling SMTP server ng customer). Operasyon createEmailMarketingSender. Mga sinuring pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: API at dashboard lamang: naglalaman ito ng lihim na hindi kailanman dapat makarating sa isang modelo ng AI (ang body ay ang SMTP password).
• DELETE /v1/email-marketing/senders/{sender_id} — Alisin ang isang koneksyon sa pagpapadala at ang nakaimbak nitong password. Operasyon deleteEmailMarketingSender. Mga sinuring pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/senders/{sender_id}/verify — Patunayang gumagana ang koneksyon sa pagpapadala, nang walang ipinapadalang anuman. Operasyon verifyEmailMarketingSender. Mga sinuring pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• PUT /v1/email-marketing/senders/{sender_id}/webhook — I-imbak ang webhook signing secret ng iyong e-mail provider para sa koneksyong ito. Operasyon setEmailMarketingSenderWebhook. Mga sinuring pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: tinatawag ng ibang sistema (isang provider o isang bisita), hindi mo tinatawag (nag-iimbak ng webhook secret ng isang provider).

SMS at WhatsApp

• GET /v1/email-marketing/sms — Ang kailangan ng screen ng SMS — bukas?, naka-pause?, balanse ng kredito at mga presyo. Operasyon getEmailMarketingSms. Mga sinuring pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• GET /v1/email-marketing/sms/campaigns — Mga maramihang kampanya ng SMS, pinakabago muna, isang pahina ng keyset. Operasyon listSmsMarketingCampaigns. Mga sinuring pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/sms/campaigns — Gumawa ng draft na SMS para sa isang listahan. Operasyon createSmsMarketingCampaign. Mga sinuring pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id} — Isang maramihang kampanya ng SMS. Operasyon getSmsMarketingCampaign. Mga sinuring pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — Mag-edit ng draft (o ng tinanggihang kampanya, na babalik sa draft). Operasyon updateSmsMarketingCampaign. Mga sinuring pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — Ang mga bilang ng isang maramihang kampanya ng SMS. Operasyon getSmsMarketingCampaignReport. Mga sinuring pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — Simulan ang pagpapadala ng SMS sa lahat ng nasa listahan nito na sumang-ayon sa SMS — o ipagpatuloy ang isa na na-pause dahil sa credit. Operation sendSmsMarketingCampaign. Mga sinuring pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: API at dashboard lang: gumagastos ito ng pera o allowance, kaya tao ang pumipindot nito (nagpapadala ng mga bayad na mensahe sa SMS/WhatsApp).
• GET /v1/email-marketing/sms/registrations/us — Ang pagpaparehistro ng US 10DLC ng organisasyong ito, at ang halaga nito. Operation getEmailMarketingUsRegistration. Mga sinuring pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/sms/registrations/us — Isumite ang brand at campaign ng organisasyong ito para sa US 10DLC (sisingilin sa pagsusumite). Operation submitEmailMarketingUsRegistration. Mga sinuring pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: API at dashboard lang: gumagastos ito ng pera o allowance, kaya tao ang pumipindot nito (may bayad sa carrier ang pagpaparehistro ng US 10DLC).

Mga campaign sa pamamagitan ng sarili ninyong serbisyo sa email (mga template, segment, suppression)

• GET /v1/campaigns — Ang mga campaign ng organisasyon. Operation listCampaigns. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/campaigns — Gumawa ng campaign mula sa isang template at audience. Operation createCampaign. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• DELETE /v1/campaigns/esp — Idiskonekta ang account ng provider at alisin ang naka-imbak nitong key. Operasyon disconnectEsp. Mula sa isang AI assistant: API at dashboard lamang: may dala itong lihim na hindi kailanman dapat makarating sa isang modelo ng AI (sinisira ang naka-imbak na ESP key).
• GET /v1/campaigns/esp — Ang sariling e-mail provider account ng organisasyon. Operasyon getEspConnection. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/campaigns/esp — Ikonekta ang isang e-mail provider account. Operasyon connectEsp. Mula sa isang AI assistant: API at dashboard lamang: may dala itong lihim na hindi kailanman dapat makarating sa isang modelo ng AI (ang body ay ang ESP API key).
• POST /v1/campaigns/esp/verify — Patunayang gumagana ang account ng provider at basahin ang mga na-verify nitong domain. Operasyon verifyEspConnection. Mula sa isang AI assistant: API at dashboard lamang: may dala itong lihim na hindi kailanman dapat makarating sa isang modelo ng AI (muling sinusuri ang isang naka-imbak na ESP key).
• POST /v1/campaigns/preview — Render ang isang template na may mga halimbawang value. Operasyon previewCampaignTemplate. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• GET /v1/campaigns/segments — Ang iyong mga naka-save na audience segment. Operasyon listCampaignSegments. Mga sinuring pahintulot: campaigns.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/campaigns/segments — Mag-save ng bagong audience segment. Operasyon createCampaignSegment. Mga sinuring pahintulot: campaigns.manage. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• GET /v1/campaigns/segments/fields — Ang bokabularyo ng filter, ang mga listahan ng halaga nito at ang mga magic tag. Operasyong getCampaignSegmentFields. Sinuring pahintulot: campaigns.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/campaigns/segments/preview — Ilang tao ang naaabot nito, kung sino sila, at kung sino ang hindi kasama. Operasyong previewCampaignSegment. Sinuring pahintulot: campaigns.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• DELETE /v1/campaigns/segments/{segmentId} — I-archive ang isang segment. Operasyong archiveCampaignSegment. Sinuring pahintulot: campaigns.manage. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• GET /v1/campaigns/segments/{segmentId} — Isang naka-save na segment. Operasyong getCampaignSegment. Sinuring pahintulot: campaigns.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• PATCH /v1/campaigns/segments/{segmentId} — Palitan ang pangalan ng isang segment o baguhin ang mga filter nito. Operasyong updateCampaignSegment. Sinuring pahintulot: campaigns.manage. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• GET /v1/campaigns/suppressions — Mga address na hindi dapat makatanggap ng marketing. Operasyong listCampaignSuppressions. Sinuring pahintulot: campaigns.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/campaigns/suppressions — Magdagdag ng address sa listahan ng pagsugpo. Operasyong createCampaignSuppression. Sinuring pahintulot: campaigns.manage. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• GET /v1/campaigns/tags — Ang palette ng magic-tag na iniaalok ng isang campaign composer. Operasyong listCampaignTags. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• GET /v1/campaigns/templates — Ang mga template ng campaign ng organisasyon. Operasyong listCampaignTemplates. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/campaigns/templates — Gumawa ng isang template ng campaign. Operasyong createCampaignTemplate. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• DELETE /v1/campaigns/templates/{templateId} — I-archive ang isang template at iretiro ang mga translation source nito. Operasyong archiveCampaignTemplate. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• GET /v1/campaigns/templates/{templateId} — Isang template ng campaign. Operasyong getCampaignTemplate. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• PUT /v1/campaigns/templates/{templateId} — I-edit ang isang template ng campaign. Operasyong updateCampaignTemplate. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/campaigns/unsubscribe — Umalis sa isang marketing list. Walang kinakailangang account. Operasyong unsubscribeFromCampaigns. Mula sa isang AI assistant: API at dashboard lamang: nagdadala ito ng lihim na hindi kailanman dapat makarating sa isang AI model (tumatanggap ng nilagdaang unsubscribe token ng tatanggap).
• DELETE /v1/campaigns/{campaignId} — Mag-delete ng campaign at iretiro ang mga delivery row nito. Operasyong deleteCampaign. Mula sa isang AI assistant: API at dashboard lamang: nangangailangan ito ng pahintulot na hindi iniaalok sa mga koneksyon ng AI (ang pag-delete ng isang ESP campaign ay nangangailangan ng campaigns.send).
• GET /v1/campaigns/{campaignId} — Isang campaign at ang ulat ng paghahatid nito. Operasyon getCampaign. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/campaigns/{campaignId}/control — I-pause, ipagpatuloy, o kanselahin ang isang tumatakbong pagpapadala. Operasyon controlCampaign. Mula sa isang AI assistant: API at dashboard lamang: gumagastos ito ng pera o allowance, kaya tao ang pumipindot nito (nagpo-pause/nagpapatuloy ng live na pagpapadala).
• POST /v1/campaigns/{campaignId}/send — Simulan ang durable na pagpapadala. Operasyon sendCampaign. Mula sa isang AI assistant: API at dashboard lamang: gumagastos ito ng pera o allowance, kaya tao ang pumipindot nito (nagpapadala ng ESP campaign sa mga totoong tatanggap).
• POST /v1/campaigns/{campaignId}/test — Magpadala ng isang totoong mensahe sa channel na aktwal na gagamitin ng campaign. Operasyon testSendCampaign. Mula sa isang AI assistant: API at dashboard lamang: nangangailangan ito ng pahintulot na hindi iniaalok sa mga koneksyon ng AI (ang isang ESP test send ay nangangailangan ng campaigns.send).

Mga pampublikong page at papasok na webhook

• GET /v1/public/email-marketing/c/{token} — Ang click counter. Nagtatala ng isang pag-click bawat tatanggap at nagre-redirect sa orihinal na link. Operasyon emailMarketingClick. Mula sa isang AI assistant: isang page na binubuksan ng iyong mga tatanggap mula sa isang email (ang pag-redirect para sa pagsubaybay sa pag-click).
• GET /v1/public/email-marketing/f/{public_id} — Naka-host na page ng sign-up form (walang pag-log in). Operasyon emailMarketingFormPage. Mula sa isang AI assistant: isang page na binubuksan ng iyong mga tatanggap mula sa isang email (ang pampublikong page ng sign-up form).
• POST /v1/public/email-marketing/f/{public_id} — Magsumite ng sign-up form (naka-host na page, embed, o JSON). Operasyong emailMarketingFormSubmit. Mula sa isang AI assistant: tinatawag ng ibang sistema (isang provider o isang bisita), hindi mo tinatawag (nagsusumite ang isang bisita ng signup form).
• GET /v1/public/email-marketing/fc — Ang double opt-in na page ng kumpirmasyon (walang login). Operasyong emailMarketingFormConfirmPage. Mula sa isang AI assistant: isang page na binubuksan ng iyong mga tatanggap mula sa isang email (ang double opt-in na page ng kumpirmasyon).
• POST /v1/public/email-marketing/fc — Kumpirmahin ang isang pag-sign up (idinaragdag ang tao sa listahan na may talaan ng pahintulot). Operasyong emailMarketingFormConfirm. Mula sa isang AI assistant: tinatawag ng ibang sistema (isang provider o isang bisita), hindi mo tinatawag (kinukumpirma ng isang bisita ang isang double opt-in).
• GET /v1/public/email-marketing/o/{token} — Ang open-tracking na larawan (isang 1x1 GIF). Nagbibilang ng isang pagbubukas bawat tatanggap. Operasyong emailMarketingOpenPixel. Mula sa isang AI assistant: isang page na binubuksan ng iyong mga tatanggap mula sa isang email (ang open-tracking pixel).
• GET /v1/public/email-marketing/u/{token} — Ang link sa pag-unsubscribe sa footer (walang login). Operasyong emailMarketingUnsubscribePage. Mula sa isang AI assistant: isang page na binubuksan ng iyong mga tatanggap mula sa isang email (ang unsubscribe page).
• POST /v1/public/email-marketing/u/{token} — RFC 8058 one-click unsubscribe (at ang button ng page na "ihinto ang lahat"). Operation emailMarketingUnsubscribeOneClick. Mula sa isang AI assistant: tinatawag ng ibang system (isang provider o isang bisita), hindi mo tinatawag (RFC 8058 one-click unsubscribe).
• GET /v1/public/email-marketing/warmup-u/{token} — Ang unsubscribe link ng marketing pool warm-up mail (walang login). Operation emailMarketingWarmupUnsubscribePage. Mula sa isang AI assistant: isang page na binubuksan ng iyong mga recipient mula sa isang email (ang warm-up unsubscribe page).
• POST /v1/public/email-marketing/warmup-u/{token} — RFC 8058 one-click unsubscribe mula sa warm-up mail. Operation emailMarketingWarmupUnsubscribeOneClick. Mula sa isang AI assistant: tinatawag ng ibang system (isang provider o isang bisita), hindi mo tinatawag (warm-up one-click unsubscribe).
• POST /v1/webhooks/campaign-events — Mag-ingest ng isang nilagdaang delivery event mula sa e-mail provider. Operation receiveCampaignDeliveryWebhook. Mula sa isang AI assistant: tinatawag ng ibang system (isang provider o isang bisita), hindi mo tinatawag (nilagdaang ESP delivery webhook).
• POST /v1/webhooks/campaigns/telnyx — Mga papasok na SMS reply (STOP / START) mula sa aming SMS vendor. Operation receiveCampaignsTelnyxInbound. Mula sa isang AI assistant: tinatawag ng ibang system (isang provider o isang bisita), hindi mo tinatawag (nilagdaang Telnyx inbound webhook).
• POST /v1/webhooks/email-marketing/{connection_id} — Mga kaganapan sa paghahatid ng sariling e-mail provider ng customer para sa isang koneksyon sa pagpapadala. Operasyong receiveEmailMarketingProviderWebhook. Mula sa isang AI assistant: tinatawag ng ibang system (isang provider o isang bisita), hindi mo tinatawag (nilagdaang webhook ng nagpadala-provider).

Mga Flow

• GET /v1/email-marketing/flows — Mga e-mail flow (pagbati, drip, taunang petsa), isang pahina ng keyset. Operasyong listEmailMarketingFlows. Sinuring mga pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/flows — Lumikha ng isang flow (nagsisimula ito bilang draft). Operasyong createEmailMarketingFlow. Sinuring mga pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• DELETE /v1/email-marketing/flows/{flow_id} — Magbura ng isang flow at ang mga pagpapatala nito (mananatili ang mga naipadala nitong run, bilang mga kampanya). Operasyong deleteEmailMarketingFlow. Sinuring mga pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• GET /v1/email-marketing/flows/{flow_id} — Isang flow kasama ang mga hakbang at ulat nito (nakatala, kasalukuyang pinoproseso, mga run at mga tatanggap sa bawat hakbang). Operasyong getEmailMarketingFlow. Sinuring mga pahintulot: email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• PATCH /v1/email-marketing/flows/{flow_id} — Baguhin ang isang flow; ang steps, kapag ibinigay, ay pinapalitan ang buong pagkakasunod-sunod. Operasyong updateEmailMarketingFlow. Mga sinuring pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/flows/{flow_id}/activate — I-on ang isang flow; tanging ang mga taong sumali sa listahan mula ngayon ang mae-enroll. Operasyong activateEmailMarketingFlow. Mga sinuring pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.
• POST /v1/email-marketing/flows/{flow_id}/pause — I-pause ang isang flow; maghihintay ang mga nakatakdang hakbang at walang bagong padadalhan ng email hanggang sa muli itong i-on. Operasyong pauseEmailMarketingFlow. Mga sinuring pahintulot: email_marketing.manage, email_marketing.view. Mula sa isang AI assistant: oo, sa pamamagitan ng MCP.