Zinn® Campaigns API dan MCP: panduan pembangun

Semua perkara yang boleh anda lakukan dalam Zinn® Campaigns pada papan pemuka juga boleh anda lakukan melalui API, dan kebanyakannya daripada pembantu AI yang disambungkan ke akaun anda melalui MCP. Panduan ini merangkumi log masuk, kebenaran, contoh yang berkesan untuk kedua-dua cara, had, ralat dan setiap satu daripada 89 operasi Campaigns. Senarai operasi di bawah dijana daripada spesifikasi API kami, jadi ia sentiasa sepadan dengan apa yang dilakukan oleh API. Setiap medan bagi setiap operasi ada dalam rujukan API di zinndigital.com/developers/api/zinn-campaigns.

Log masuk

• Kunci API. Cipta kunci dalam papan pemuka di bawah Tetapan → Kunci API dan hantarkannya sebagai Authorization: Bearer zdk_live_… (kunci zdk_test_… berfungsi dalam mod kotak pasir). Berikan kunci kebenaran Kempen yang diperlukannya sahaja dan tidak lebih daripada itu.
• Pembantu AI (MCP). Sambungkan Claude, ChatGPT, Cursor atau mana-mana klien MCP ke https://api.zinndigital.com/v1/mcp, sama ada dengan log masuk daripada aplikasi atau dengan token sambungan (zmcp_live_…). Lihat Menyambungkan Claude, Cursor atau ChatGPT ke akaun anda. Pada skrin persetujuan, tandakan kebenaran Zinn® Campaigns.
• Kebenaran. email_marketing.view membaca kempen, senarai, kenalan, borang, penghantar, tetapan SMS dan laporan; email_marketing.manage mencipta dan mengubahnya. Kempen yang anda hantar melalui perkhidmatan e-mel anda sendiri menggunakan campaigns.view dan campaigns.manage.
• Penyedia semula. Hantar org_id untuk bertindak bagi pihak salah satu organisasi pelanggan anda. Abaikan parameter ini apabila kunci atau sambungan anda hanya melibatkan tepat satu organisasi.

Contoh: cipta draf kempen dengan 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"
}'

Jawapannya ialah 201 bersama draf tersebut. Ujinya dengan POST /v1/email-marketing/campaigns/{campaign_id}/test, semaknya dengan GET /v1/email-marketing/campaigns/{campaign_id}/lint, dan hantarnya dengan POST /v1/email-marketing/campaigns/{campaign_id}/send.

Contoh: draf yang sama daripada pembantu AI

Minta pembantu anda dengan kata-kata yang mudah, contohnya "draf e-mel Zinn® Campaigns yang dinamakan Spring sale dengan subjek 'Our spring sale starts today'". Di sebalik tabir, ia mencari operasi tersebut dengan api_operations_search, membaca parameternya dengan api_operation_get, dan menjalankannya dengan 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"
      }
    }
  }
}

Perkara yang tidak akan dilakukan oleh pembantu. Apa-apa sahaja yang menghantar kepada penerima anda atau membelanjakan wang atau peruntukan — menghantar kempen, menghantar mesej SMS atau WhatsApp, menulis dengan kredit AI, mendaftar untuk penghantaran teks US — akan ditolak kepada pembantu, supaya arahan yang disalah fahami tidak akan sampai kepada pelanggan anda. Pembantu menyediakan draf; anda menekan Send di papan pemuka atau memanggil API itu sendiri. Rahsia seperti kata laluan SMTP juga tidak pernah dihantar melalui pembantu: masukkannya di papan pemuka.

Had

• 1,200 permintaan seminit untuk setiap individu atau kunci API, dan 6,000 permintaan seminit untuk setiap organisasi. Had yang lebih ketat antara kedua-duanya terpakai.
• 600 permintaan seminit untuk setiap sambungan MCP.
• Melebihi had, jawapannya ialah 429 dengan pengepala Retry-After: tunggu selama bilangan saat tersebut.
• Menambah ahli senarai mengambil paling banyak 1,000 alamat setiap permintaan; peruntukan kenalan dan e-mel pelan anda terpakai kepada semua perkara yang anda lakukan melalui API.

Ralat

Setiap ralat mempunyai bentuk yang sama:

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

code tidak pernah berubah untuk masalah yang sama, jadi uji ia berbanding message. Nyatakan request_id apabila anda menghubungi sokongan. Jawapan yang akan anda temui: 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 CONFLICT, 422 UNPROCESSABLE_ENTITY, 429 TOO_MANY_REQUESTS. 403 bermakna kunci atau sambungan tidak mempunyai kebenaran yang dinamakan dalam senarai di bawah; 404 juga merangkumi sesuatu dalam organisasi yang tidak dapat anda lihat; 422 menyenaraikan setiap medan yang salah dalam details; selepas 429, tunggu bilangan saat dalam pengepala Retry-After.

Webhooks

Hasil penghantaran masuk ke dalam Zinn® Campaigns daripada penyedia yang menghantar e-mel anda:

• Dengan penyedia anda sendiri (contohnya Resend), simpan rahsia menandatangani webhook miliknya pada sambungan penghantaran dalam papan pemuka (Kempen → Penghantaran). Anda mendapat webhook_url; halakan peristiwa dihantar, melantun dan diadukan milik penyedia kepadanya. Lantunan atau aduan spam mengalih keluar alamat tersebut daripada penghantaran masa hadapan serta-merta.
• Dengan penghantaran Zinn®, tiada apa-apa untuk disediakan.

Baca hasil dengan operasi laporan (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).

Setiap operasi Campaigns

Gambaran keseluruhan

• GET /v1/email-marketing — Gambaran keseluruhan Zinn® Campaigns untuk satu organisasi. Operasi getEmailMarketingOverview. Kebenaran diperiksa: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.

Kempen e-mel

• GET /v1/email-marketing/campaigns — Kempen e-mel, terbaharu dahulu, satu halaman keyset. Operasi listEmailMarketingCampaigns. Keizinan diperiksa: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/campaigns — Cipta draf kempen e-mel. Operasi createEmailMarketingCampaign. Keizinan diperiksa: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• GET /v1/email-marketing/campaigns/{campaign_id} — Satu kempen e-mel. Operasi getEmailMarketingCampaign. Keizinan diperiksa: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• PATCH /v1/email-marketing/campaigns/{campaign_id} — Edit draf (atau kempen yang ditolak, yang kembali ke draf). Operasi updateEmailMarketingCampaign. Keizinan diperiksa: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/lint — Periksa teks kempen untuk isu kebolehhantaran sebelum dihantar. Operasi lintEmailMarketingCampaign. Keizinan diperiksa: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/report — Statistik kempen. Operasi getEmailMarketingCampaignReport. Keizinan diperiksa: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/send — Mula menghantar kempen ke senarainya. Operasi sendEmailMarketingCampaign. Kebenaran yang disemak: email_marketing.manage, email_marketing.view. Daripada pembantu AI: API dan papan pemuka sahaja: ia menggunakan wang atau peruntukan, jadi seseorang perlu menekannya (menghantar kepada penerima sebenar dan menggunakan peruntukan).
• POST /v1/email-marketing/campaigns/{campaign_id}/test — Hantar satu salinan ujian sekarang kepada ahli organisasi. Operasi testEmailMarketingCampaign. Kebenaran yang disemak: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/translate — Terjemahkan kempen ke dalam setiap bahasa kenalan yang tiada atau lapuk. Operasi translateEmailMarketingCampaign. Kebenaran yang disemak: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/translations — Setiap bahasa kenalan bagi senarai kempen dan sama ada terjemahannya adalah terkini. Operasi listEmailMarketingCampaignTranslations. Kebenaran yang disemak: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.

Menulis dengan AI

• POST /v1/email-marketing/ai/write — Tulis draf e-mel kempen daripada ringkasan ringkas dengan Zinn® AI. Operasi writeEmailMarketingCampaignWithAi. Keizinan diperiksa: email_marketing.manage, email_marketing.view. Daripada pembantu AI: API dan papan pemuka sahaja: ia menggunakan wang atau peruntukan, jadi manusia perlu menekannya (penulisan AI menggunakan kredit AI).

Kit jenama

• GET /v1/email-marketing/brand-kit — Kit jenama organisasi (nama, logo, warna, fon, gaya suara). Operasi getEmailMarketingBrandKit. Keizinan diperiksa: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• PUT /v1/email-marketing/brand-kit — Edit kit jenama. Operasi updateEmailMarketingBrandKit. Keizinan diperiksa: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/brand-kit/read — Baca kit jenama daripada laman web organisasi. Operasi readEmailMarketingBrandKit. Keizinan diperiksa: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.

Kenalan dan mesej sekali hantar

• GET /v1/email-marketing/contacts — Kenalan organisasi, satu halaman keyset pada satu masa. Operasi listEmailMarketingContacts. Keizinan yang disemak: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/contacts/{contact_id}/messages — Hantar satu SMS kepada satu kenalan, dibayar daripada baki kredit Zinn®. Operasi sendEmailMarketingMessage. Keizinan yang disemak: email_marketing.manage, email_marketing.view. Daripada pembantu AI: API dan papan pemuka sahaja: ia membelanjakan wang atau elaun, jadi seseorang perlu menekannya (mesej satu kali kepada kenalan membelanjakan elaun).
• GET /v1/email-marketing/messages — Mesej SMS dan WhatsApp yang dihantar oleh organisasi, yang terbaharu dahulu, satu halaman keyset. Operasi listEmailMarketingMessages. Keizinan yang disemak: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.

Senarai

• GET /v1/email-marketing/lists — Senarai mel organisasi dengan bilangan yang melanggan / berhenti melanggan. Operasi listEmailMarketingLists. Kebenaran yang diperiksa: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/lists — Cipta senarai mel (atau kembalikan senarai dengan nama tersebut). Operasi createEmailMarketingList. Kebenaran yang diperiksa: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/lists/{list_id}/members — Tambah kenalan ke senarai melalui alamat e-mel (maksimum 1,000 setiap permintaan). Operasi addEmailMarketingListMembers. Kebenaran yang diperiksa: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.

Imports

• GET /v1/email-marketing/imports — Import kenalan yang lalu, terbaharu dahulu, satu halaman keyset pada satu masa. Operasi listEmailMarketingImports. Kebenaran yang diperiksa: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/imports — Import satu bahagian kenalan bersama perakuan persetujuannya. Operasi createEmailMarketingImport. Kebenaran yang diperiksa: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.

Sign-up forms

• GET /v1/email-marketing/forms — Borang pendaftaran (double opt-in), yang terbaharu dahulu, satu halaman keyset. Operasi listEmailMarketingForms. Kebenaran yang disemak: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/forms — Cipta borang pendaftaran yang menambahkan individu yang disahkan ke dalam satu senarai. Operasi createEmailMarketingForm. Kebenaran yang disemak: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• DELETE /v1/email-marketing/forms/{form_id} — Padam borang pendaftaran (individu yang sudah disahkan kekal dalam senarai). Operasi deleteEmailMarketingForm. Kebenaran yang disemak: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• PATCH /v1/email-marketing/forms/{form_id} — Ubah borang pendaftaran (kata-kata, senarai, pengalihan, hidup atau mati). Operasi updateEmailMarketingForm. Kebenaran yang disemak: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.

Sambungan penghantaran

• GET /v1/email-marketing/senders — Sambungan penghantaran organisasi. Operasi listEmailMarketingSenders. Keizinan diperiksa: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/senders — Sambungkan penghantar kempen (penghantaran Zinn®, atau pelayan SMTP pelanggan sendiri). Operasi createEmailMarketingSender. Keizinan diperiksa: email_marketing.manage, email_marketing.view. Daripada pembantu AI: API dan papan pemuka sahaja: ia membawa rahsia yang tidak boleh sampai ke model AI (badan permintaan ialah kata laluan SMTP).
• DELETE /v1/email-marketing/senders/{sender_id} — Alih keluar sambungan penghantaran dan kata laluan tersimpannya. Operasi deleteEmailMarketingSender. Keizinan diperiksa: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/senders/{sender_id}/verify — Buktikan bahawa sambungan penghantaran berfungsi, tanpa menghantar apa-apa. Operasi verifyEmailMarketingSender. Keizinan diperiksa: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• PUT /v1/email-marketing/senders/{sender_id}/webhook — Simpan rahsia menandatangani webhook pembekal e-mel anda untuk sambungan ini. Operasi setEmailMarketingSenderWebhook. Keizinan diperiksa: email_marketing.manage, email_marketing.view. Daripada pembantu AI: dipanggil oleh sistem lain (pembekal atau pelawat), bukan oleh anda (menyimpan rahsia webhook pembekal).

SMS dan WhatsApp

• GET /v1/email-marketing/sms — Perkara yang diperlukan oleh skrin SMS — terbuka?, dijeda?, baki kredit dan harga. Operasi getEmailMarketingSms. Keizinan yang disemak: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• GET /v1/email-marketing/sms/campaigns — Kempen SMS pukal, yang terbaharu dahulu, satu halaman keyset. Operasi listSmsMarketingCampaigns. Keizinan yang disemak: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/sms/campaigns — Cipta draf SMS kepada senarai. Operasi createSmsMarketingCampaign. Keizinan yang disemak: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id} — Satu kempen SMS pukal. Operasi getSmsMarketingCampaign. Keizinan yang disemak: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — Edit draf (atau kempen yang ditolak, yang kembali kepada draf). Operasi updateSmsMarketingCampaign. Keizinan yang disemak: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — Statistik kempen SMS pukal. Operasi getSmsMarketingCampaignReport. Keizinan yang disemak: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — Mula menghantar SMS kepada semua orang dalam senarainya yang bersetuju menerima SMS — atau sambung semula kempen yang dijeda kerana kredit. Operasi sendSmsMarketingCampaign. Kebenaran diperiksa: email_marketing.manage, email_marketing.view. Daripada pembantu AI: API dan papan pemuka sahaja: ia membelanjakan wang atau peruntukan, jadi seseorang perlu menekannya (menghantar mesej SMS/WhatsApp berbayar).
• GET /v1/email-marketing/sms/registrations/us — Pendaftaran US 10DLC organisasi ini, dan kos yang dikenakan. Operasi getEmailMarketingUsRegistration. Kebenaran diperiksa: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/sms/registrations/us — Serahkan jenama dan kempen organisasi ini untuk US 10DLC (dikenakan bayaran semasa penghantaran). Operasi submitEmailMarketingUsRegistration. Kebenaran diperiksa: email_marketing.manage, email_marketing.view. Daripada pembantu AI: API dan papan pemuka sahaja: ia membelanjakan wang atau peruntukan, jadi seseorang perlu menekannya (pendaftaran US 10DLC melibatkan yuran pembawa).

Kempen melalui perkhidmatan e-mel anda sendiri (templat, segmen, penindasan)

• GET /v1/campaigns — Kempen organisasi. Operasi listCampaigns. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/campaigns — Cipta kempen daripada templat dan khalayak. Operasi createCampaign. Daripada pembantu AI: ya, melalui MCP.
• DELETE /v1/campaigns/esp — Putuskan sambungan akaun penyedia dan alih keluar kuncinya yang disimpan. Operasi disconnectEsp. Daripada pembantu AI: API dan papan pemuka sahaja: ia membawa rahsia yang tidak boleh sampai kepada model AI (memusnahkan kunci ESP yang disimpan).
• GET /v1/campaigns/esp — Akaun penyedia e-mel organisasi itu sendiri. Operasi getEspConnection. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/campaigns/esp — Sambungkan akaun penyedia e-mel. Operasi connectEsp. Daripada pembantu AI: API dan papan pemuka sahaja: ia membawa rahsia yang tidak boleh sampai kepada model AI (badan ialah kunci API ESP).
• POST /v1/campaigns/esp/verify — Buktikan akaun penyedia berfungsi dan baca domain yang disahkan. Operasi verifyEspConnection. Daripada pembantu AI: API dan papan pemuka sahaja: ia membawa rahsia yang tidak boleh sampai kepada model AI (menyemak semula kunci ESP yang disimpan).
• POST /v1/campaigns/preview — Render templat dengan nilai contoh. Operasi previewCampaignTemplate. Daripada pembantu AI: ya, melalui MCP.
• GET /v1/campaigns/segments — Segmen khalayak anda yang disimpan. Operasi listCampaignSegments. Keizinan diperiksa: campaigns.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/campaigns/segments — Simpan segmen khalayak baharu. Operasi createCampaignSegment. Keizinan diperiksa: campaigns.manage. Daripada pembantu AI: ya, melalui MCP.
• GET /v1/campaigns/segments/fields — Kosa kata penapis, senarai nilainya dan teg ajaib. Operasi getCampaignSegmentFields. Kebenaran yang disemak: campaigns.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/campaigns/segments/preview — Jumlah capaian individu, siapa mereka, dan siapa yang dikecualikan. Operasi previewCampaignSegment. Kebenaran yang disemak: campaigns.view. Daripada pembantu AI: ya, melalui MCP.
• DELETE /v1/campaigns/segments/{segmentId} — Arkibkan segmen. Operasi archiveCampaignSegment. Kebenaran yang disemak: campaigns.manage. Daripada pembantu AI: ya, melalui MCP.
• GET /v1/campaigns/segments/{segmentId} — Satu segmen yang disimpan. Operasi getCampaignSegment. Kebenaran yang disemak: campaigns.view. Daripada pembantu AI: ya, melalui MCP.
• PATCH /v1/campaigns/segments/{segmentId} — Namakan semula segmen atau tukar penapisnya. Operasi updateCampaignSegment. Kebenaran yang disemak: campaigns.manage. Daripada pembantu AI: ya, melalui MCP.
• GET /v1/campaigns/suppressions — Alamat yang tidak boleh menerima pemasaran. Operasi listCampaignSuppressions. Kebenaran yang disemak: campaigns.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/campaigns/suppressions — Tambah alamat ke dalam senarai sekatan. Operasi createCampaignSuppression. Kebenaran yang disemak: campaigns.manage. Daripada pembantu AI: ya, melalui MCP.
• GET /v1/campaigns/tags — Palet tag ajaib yang ditawarkan oleh penggubah kempen. Operasi listCampaignTags. Daripada pembantu AI: ya, melalui MCP.
• GET /v1/campaigns/templates — Templat kempen organisasi. Operasi listCampaignTemplates. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/campaigns/templates — Cipta templat kempen. Operasi createCampaignTemplate. Daripada pembantu AI: ya, melalui MCP.
• DELETE /v1/campaigns/templates/{templateId} — Arkibkan templat dan hentikan sumber terjemahannya. Operasi archiveCampaignTemplate. Daripada pembantu AI: ya, melalui MCP.
• GET /v1/campaigns/templates/{templateId} — Satu templat kempen. Operasi getCampaignTemplate. Daripada pembantu AI: ya, melalui MCP.
• PUT /v1/campaigns/templates/{templateId} — Edit templat kempen. Operasi updateCampaignTemplate. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/campaigns/unsubscribe — Tinggalkan senarai pemasaran. Tiada akaun diperlukan. Operasi unsubscribeFromCampaigns. Daripada pembantu AI: API dan papan pemuka sahaja: ia membawa rahsia yang tidak boleh sampai kepada model AI (menerima token nyahlanggan bertandatangan penerima).
• DELETE /v1/campaigns/{campaignId} — Padam kempen dan hentikan baris penghantarannya. Operasi deleteCampaign. Daripada pembantu AI: API dan papan pemuka sahaja: ia memerlukan kebenaran yang tidak ditawarkan kepada sambungan AI (memadamkan kempen ESP memerlukan campaigns.send).
• GET /v1/campaigns/{campaignId} — Satu kempen dan laporan penghantarannya. Operasi getCampaign. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/campaigns/{campaignId}/control — Jeda, sambung semula atau batalkan penghantaran yang sedang berjalan. Operasi controlCampaign. Daripada pembantu AI: API dan papan pemuka sahaja: ia menggunakan wang atau elaun, jadi seseorang perlu menekannya (menjeda/menyambung semula penghantaran langsung).
• POST /v1/campaigns/{campaignId}/send — Mulakan penghantaran tahan lama. Operasi sendCampaign. Daripada pembantu AI: API dan papan pemuka sahaja: ia menggunakan wang atau elaun, jadi seseorang perlu menekannya (menghantar kempen ESP kepada penerima sebenar).
• POST /v1/campaigns/{campaignId}/test — Hantar satu mesej sebenar pada saluran yang akan digunakan oleh kempen tersebut. Operasi testSendCampaign. Daripada pembantu AI: API dan papan pemuka sahaja: ia memerlukan kebenaran yang tidak ditawarkan kepada sambungan AI (penghantaran ujian ESP memerlukan campaigns.send).

Halaman awam dan webhook masuk

• GET /v1/public/email-marketing/c/{token} — Kaunter klik. Merekodkan satu klik bagi setiap penerima dan mengubah hala ke pautan asal. Operasi emailMarketingClick. Daripada pembantu AI: halaman yang dibuka oleh penerima anda daripada e-mel (ubah hala penjejakan klik).
• GET /v1/public/email-marketing/f/{public_id} — Halaman dihoskan bagi borang pendaftaran (tiada log masuk). Operasi emailMarketingFormPage. Daripada pembantu AI: halaman yang dibuka oleh penerima anda daripada e-mel (halaman borang pendaftaran awam).
• POST /v1/public/email-marketing/f/{public_id} — Hantar borang pendaftaran (halaman dihoskan, benaman atau JSON). Operasi emailMarketingFormSubmit. Daripada pembantu AI: dipanggil oleh sistem lain (penyedia atau pelawat), bukan oleh anda (pelawat menghantar borang pendaftaran).
• GET /v1/public/email-marketing/fc — Halaman pengesahan ikut serta dua kali (tiada log masuk). Operasi emailMarketingFormConfirmPage. Daripada pembantu AI: halaman yang dibuka oleh penerima anda daripada e-mel (halaman pengesahan ikut serta dua kali).
• POST /v1/public/email-marketing/fc — Sahkan pendaftaran (menambahkan individu tersebut ke dalam senarai berserta rekod kebenaran). Operasi emailMarketingFormConfirm. Daripada pembantu AI: dipanggil oleh sistem lain (penyedia atau pelawat), bukan oleh anda (pelawat mengesahkan ikut serta dua kali).
• GET /v1/public/email-marketing/o/{token} — Imej penjejakan buka (GIF 1x1). Mengira satu bukaan bagi setiap penerima. Operasi emailMarketingOpenPixel. Daripada pembantu AI: halaman yang dibuka oleh penerima anda daripada e-mel (piksel penjejakan buka).
• GET /v1/public/email-marketing/u/{token} — Pautan berhenti melanggan pengaki (tiada log masuk). Operasi emailMarketingUnsubscribePage. Daripada pembantu AI: halaman yang dibuka oleh penerima anda daripada e-mel (halaman berhenti melanggan).
• POST /v1/public/email-marketing/u/{token} — Nyahlanggan satu klik RFC 8058 (dan butang "hentikan semua" halaman). Operasi emailMarketingUnsubscribeOneClick. Daripada pembantu AI: dipanggil oleh sistem lain (penyedia atau pelawat), bukan oleh anda (nyahlanggan satu klik RFC 8058).
• GET /v1/public/email-marketing/warmup-u/{token} — Pautan nyahlanggan e-mel pemanasan kumpulan pemasaran (tanpa log masuk). Operasi emailMarketingWarmupUnsubscribePage. Daripada pembantu AI: halaman yang dibuka oleh penerima anda daripada e-mel (halaman nyahlanggan pemanasan).
• POST /v1/public/email-marketing/warmup-u/{token} — Nyahlanggan satu klik RFC 8058 daripada e-mel pemanasan. Operasi emailMarketingWarmupUnsubscribeOneClick. Daripada pembantu AI: dipanggil oleh sistem lain (penyedia atau pelawat), bukan oleh anda (nyahlanggan satu klik pemanasan).
• POST /v1/webhooks/campaign-events — Menginges peristiwa penghantaran yang ditandatangani daripada penyedia e-mel. Operasi receiveCampaignDeliveryWebhook. Daripada pembantu AI: dipanggil oleh sistem lain (penyedia atau pelawat), bukan oleh anda (webhook penghantaran ESP yang ditandatangani).
• POST /v1/webhooks/campaigns/telnyx — Balasan SMS masuk (STOP / START) daripada vendor SMS kami. Operasi receiveCampaignsTelnyxInbound. Daripada pembantu AI: dipanggil oleh sistem lain (penyedia atau pelawat), bukan oleh anda (webhook masuk Telnyx yang ditandatangani).
• POST /v1/webhooks/email-marketing/{connection_id} — Peristiwa penghantaran pembekal e-mel pelanggan sendiri untuk satu sambungan penghantaran. Operasi receiveEmailMarketingProviderWebhook. Daripada pembantu AI: dipanggil oleh sistem lain (pembekal atau pelawat), bukan oleh anda (webhook penghantar-pembekal yang ditandatangani).

Flows

• GET /v1/email-marketing/flows — Aliran e-mel (alu-aluan, titisan, tarikh tahunan), satu halaman set kunci. Operasi listEmailMarketingFlows. Kebenaran diperiksa: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/flows — Cipta aliran (ia bermula sebagai draf). Operasi createEmailMarketingFlow. Kebenaran diperiksa: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• DELETE /v1/email-marketing/flows/{flow_id} — Padamkan aliran dan pendaftarannya (larian yang dihantar kekal, sebagai kempen). Operasi deleteEmailMarketingFlow. Kebenaran diperiksa: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• GET /v1/email-marketing/flows/{flow_id} — Satu aliran berserta langkah dan laporannya (didaftarkan, sedang berjalan, larian dan penerima bagi setiap langkah). Operasi getEmailMarketingFlow. Kebenaran diperiksa: email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• PATCH /v1/email-marketing/flows/{flow_id} — Ubah aliran; steps, apabila diberikan, menggantikan keseluruhan urutan. Operasi updateEmailMarketingFlow. Keizinan yang disemak: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/flows/{flow_id}/activate — Hidupkan aliran; hanya individu yang menyertai senarai mulai sekarang didaftarkan. Operasi activateEmailMarketingFlow. Keizinan yang disemak: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.
• POST /v1/email-marketing/flows/{flow_id}/pause — Jeda aliran; langkah yang perlu dijalankan menunggu dan tiada orang baharu yang dihantar e-mel sehingga ia dihidupkan semula. Operasi pauseEmailMarketingFlow. Keizinan yang disemak: email_marketing.manage, email_marketing.view. Daripada pembantu AI: ya, melalui MCP.