Vše, co můžete v Zinn® Campaigns dělat na nástěnce, můžete provádět také prostřednictvím rozhraní API a většinu z toho i z asistenta AI připojeného k vašemu účtu přes MCP. Tento průvodce se věnuje přihlašování, oprávněním, praktickému příkladu pro oba způsoby, limitům, chybám a každé z 89 operací Campaigns. Níže uvedený seznam operací je generován z naší specifikace API, takže vždy přesně odpovídá tomu, co rozhraní API provádí. Každé pole každé operace je uvedeno v referenční příručce k API na adrese zinndigital.com/developers/api/zinn-campaigns.
Přihlašování
- Klíče API. Vytvořte klíč na řídicím panelu v části Nastavení → Klíče API a odešlete jej jako
Authorization: Bearer zdk_live_… (klíč zdk_test_… funguje v režimu sandboxu). Udělte klíči pouze ta oprávnění pro Kampaně, která potřebuje, a nic víc.
- Asistenti AI (MCP). Připojte Claude, ChatGPT, Cursor nebo libovolného klienta MCP k
https://api.zinndigital.com/v1/mcp, a to buď přihlášením z aplikace, nebo pomocí tokenu připojení (zmcp_live_…). Viz Připojení Claude, Cursor nebo ChatGPT k vašemu účtu. Na obrazovce se souhlasem zaškrtněte oprávnění pro Zinn® Campaigns.
- Oprávnění. Oprávnění
email_marketing.view čte kampaně, seznamy, kontakty, formuláře, odesílatele, nastavení SMS a přehledy; email_marketing.manage je vytváří a upravuje. Kampaně, které odesíláte prostřednictvím vlastní e-mailové služby, používají campaigns.view a campaigns.manage.
- Prodejci. Chcete-li provádět akce jménem některé ze svých klientských organizací, předejte
org_id. Vynechejte jej, pokud má váš klíč nebo připojení přístup pouze k jedné organizaci.
Příklad: vytvoření konceptu kampaně pomocí 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"
}'
Odpověď je 201 s konceptem. Otestujte jej pomocí POST /v1/email-marketing/campaigns/{campaign_id}/test, zkontrolujte jej pomocí GET /v1/email-marketing/campaigns/{campaign_id}/lint a odešlete jej pomocí POST /v1/email-marketing/campaigns/{campaign_id}/send.
Příklad: stejný koncept od asistenta s umělou inteligencí
Požádejte svého asistenta běžnými slovy, například „vytvoř koncept e-mailu v Zinn® Campaigns s názvem Jarní výprodej a předmětem ‚Náš jarní výprodej začíná dnes‘“. Na pozadí vyhledá operaci pomocí api_operations_search, načte její parametry pomocí api_operation_get a spustí ji pomocí 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"
}
}
}
}
Co asistent neudělá. Vše, co odesílá zprávy příjemcům nebo čerpá peníze či kvóty – odeslání kampaně, odesílání SMS nebo zpráv přes WhatsApp, psaní pomocí kreditů AI, registrace k odesílání textových zpráv v US – je asistentovi odepřeno, takže špatně pochopený pokyn se k vašim zákazníkům nikdy nedostane. Asistent připraví koncept; tlačítko Odeslat stisknete na nástěnce nebo rozhraní API zavoláte sami. Důvěrné údaje, jako je heslo SMTP, se přes asistenta také nikdy nepředávají: zadejte je na nástěnce.
Limity
- 1 200 požadavků za minutu pro každou osobu nebo klíč API a 6 000 požadavků za minutu pro každou organizaci. Uplatní se přísnější z obou limitů.
- 600 požadavků za minutu pro každé připojení MCP.
- Při překročení limitu je odpovědí kód
429 se záhlavím Retry-After: počkejte uvedený počet sekund.
- Přidávání členů seznamu přijímá nanejvýš 1 000 adres na jeden požadavek; kvóty kontaktů a e-mailů vašeho tarifu platí pro vše, co prostřednictvím rozhraní API děláte.
Chyby
Každá chyba má stejnou strukturu:
{"error": {"code": "UNPROCESSABLE_ENTITY", "message": "…", "details": [{"field": "subject", "code": "REQUIRED", "message": "…"}], "request_id": "…"}}
code se pro stejný problém nikdy nemění, proto testujte raději ten než message. Při kontaktování podpory uveďte request_id. Odpovědi, se kterými se setkáte: 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 CONFLICT, 422 UNPROCESSABLE_ENTITY, 429 TOO_MANY_REQUESTS. Kód 403 znamená, že klíči nebo připojení chybí oprávnění uvedené v níže uvedeném seznamu; 404 pokrývá také položku v organizaci, kterou nemůžete vidět; 422 uvádí každé chybné pole v details; po 429 vyčkejte počet sekund uvedený v hlavičce Retry-After.
Webhooky
Výsledky doručení přicházejí do Zinn® Campaigns od poskytovatele, který odesílá váš e-mail:
- S vlastním poskytovatelem (například Resend) uložte jeho podpisový tajný klíč webhooku u odesílacího připojení na řídicím panelu (Kampaně → Odesílání). Získáte
webhook_url; nasměrujte na ni události doručení, vrácení a stížnosti od poskytovatele. Vrácení nebo stížnost na spam adresu okamžitě odebere z budoucích odesílání.
- S odesíláním přes Zinn® není třeba nic nastavovat.
Přečtěte si výsledky pomocí operací pro hlášení (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).
Každá operace Campaigns
Přehled
GET /v1/email-marketing — Přehled Zinn® Campaigns pro jednu organizaci. Operace getEmailMarketingOverview. Kontrolovaná oprávnění: email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
E-mailové kampaně
GET /v1/email-marketing/campaigns — E-mailové kampaně, nejnovější jako první, jedna stránka keyset stránkování. Operace listEmailMarketingCampaigns. Kontrolovaná oprávnění: email_marketing.view. Z AI asistenta: ano, prostřednictvím MCP.
POST /v1/email-marketing/campaigns — Vytvoření konceptu e-mailové kampaně. Operace createEmailMarketingCampaign. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z AI asistenta: ano, prostřednictvím MCP.
GET /v1/email-marketing/campaigns/{campaign_id} — Jedna e-mailová kampaň. Operace getEmailMarketingCampaign. Kontrolovaná oprávnění: email_marketing.view. Z AI asistenta: ano, prostřednictvím MCP.
PATCH /v1/email-marketing/campaigns/{campaign_id} — Úprava konceptu (nebo zamítnuté kampaně, která se vrátí do stavu konceptu). Operace updateEmailMarketingCampaign. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z AI asistenta: ano, prostřednictvím MCP.
GET /v1/email-marketing/campaigns/{campaign_id}/lint — Kontrola textu kampaně na problémy s doručitelností před jejím odesláním. Operace lintEmailMarketingCampaign. Kontrolovaná oprávnění: email_marketing.view. Z AI asistenta: ano, prostřednictvím MCP.
GET /v1/email-marketing/campaigns/{campaign_id}/report — Čísla kampaně. Operace getEmailMarketingCampaignReport. Kontrolovaná oprávnění: email_marketing.view. Z AI asistenta: ano, prostřednictvím MCP.
POST /v1/email-marketing/campaigns/{campaign_id}/send — Zahájit odesílání kampaně na její seznam. Operace sendEmailMarketingCampaign. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z asistenta AI: Pouze rozhraní API a řídicí panel: spotřebovává peníze nebo kvótu, takže jej musí stisknout člověk (odesílá skutečným příjemcům a čerpá kvótu).
POST /v1/email-marketing/campaigns/{campaign_id}/test — Odeslat nyní jednu zkušební kopii členovi organizace. Operace testEmailMarketingCampaign. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z asistenta AI: Ano, prostřednictvím MCP.
POST /v1/email-marketing/campaigns/{campaign_id}/translate — Přeložit kampaň do každého jazyka kontaktů, který chybí nebo je neaktuální. Operace translateEmailMarketingCampaign. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z asistenta AI: Ano, prostřednictvím MCP.
GET /v1/email-marketing/campaigns/{campaign_id}/translations — Každý jazyk kontaktů v seznamu kampaně a informace o tom, zda je jeho překlad aktuální. Operace listEmailMarketingCampaignTranslations. Kontrolovaná oprávnění: email_marketing.view. Z asistenta AI: Ano, prostřednictvím MCP.
Psaní pomocí AI
POST /v1/email-marketing/ai/write — Napište koncept e-mailu kampaně ze stručného zadání pomocí Zinn® AI. Operace writeEmailMarketingCampaignWithAi. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z AI asistenta: pouze rozhraní API a administrační nástěnka: spotřebovává peníze nebo příděl, takže jej stiskne člověk (psaní pomocí AI spotřebovává AI kredity).
Brand kit
GET /v1/email-marketing/brand-kit — Brand kit organizace (název, logo, barvy, písmo, tón komunikace). Operace getEmailMarketingBrandKit. Kontrolovaná oprávnění: email_marketing.view. Z AI asistenta: ano, prostřednictvím MCP.
PUT /v1/email-marketing/brand-kit — Upravte brand kit. Operace updateEmailMarketingBrandKit. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z AI asistenta: ano, prostřednictvím MCP.
POST /v1/email-marketing/brand-kit/read — Načtěte brand kit z webu organizace. Operace readEmailMarketingBrandKit. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z AI asistenta: ano, prostřednictvím MCP.
Kontakty a jednorázové zprávy
GET /v1/email-marketing/contacts — Kontakty organizace, po jedné stránce keyset. Operace listEmailMarketingContacts. Kontrolovaná oprávnění: email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
POST /v1/email-marketing/contacts/{contact_id}/messages — Odeslat jednu SMS jednomu kontaktu, hrazeno ze zůstatku kreditu Zinn®. Operace sendEmailMarketingMessage. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z asistenta AI: pouze API a nástěnka: utrácí peníze nebo kvótu, takže tlačítko stiskne člověk (jednorázová zpráva kontaktu čerpá kvótu).
GET /v1/email-marketing/messages — Zprávy SMS a WhatsApp odeslané organizací, od nejnovějších, jedna stránka keyset. Operace listEmailMarketingMessages. Kontrolovaná oprávnění: email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
Seznamy
GET /v1/email-marketing/lists — E-mailové konference organizace s počty přihlášených / odhlášených. Operace listEmailMarketingLists. Kontrolovaná oprávnění: email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
POST /v1/email-marketing/lists — Vytvoří e-mailovou konferenci (nebo vrátí konferenci s tímto názvem). Operace createEmailMarketingList. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
POST /v1/email-marketing/lists/{list_id}/members — Přidá kontakty do konference podle e-mailové adresy (maximálně 1 000 na požadavek). Operace addEmailMarketingListMembers. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
Importy
GET /v1/email-marketing/imports — Minulé importy kontaktů, nejnovější jako první, po jedné stránce keyset. Operace listEmailMarketingImports. Kontrolovaná oprávnění: email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
POST /v1/email-marketing/imports — Importuje jeden blok kontaktů s potvrzením o udělení souhlasu. Operace createEmailMarketingImport. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
Registrační formuláře
GET /v1/email-marketing/forms — Registrační formuláře (double opt-in), nejnovější jako první, jedna stránka keyset. Operace listEmailMarketingForms. Kontrolovaná oprávnění: email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
POST /v1/email-marketing/forms — Vytvořit registrační formulář, který přidává potvrzené osoby do jednoho seznamu. Operace createEmailMarketingForm. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
DELETE /v1/email-marketing/forms/{form_id} — Smazat registrační formulář (již potvrzené osoby zůstanou v seznamu). Operace deleteEmailMarketingForm. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
PATCH /v1/email-marketing/forms/{form_id} — Upravit registrační formulář (znění, seznam, přesměrování, zapnuto nebo vypnuto). Operace updateEmailMarketingForm. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
Připojení pro odesílání
GET /v1/email-marketing/senders — Odesílací spojení organizace. Operace listEmailMarketingSenders. Kontrolovaná oprávnění: email_marketing.view. Z AI asistenta: ano, prostřednictvím MCP.
POST /v1/email-marketing/senders — Připojit odesílatele kampaně (odesílání Zinn® nebo vlastní SMTP server zákazníka). Operace createEmailMarketingSender. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z AI asistenta: pouze API a administrační nástěnka: nese tajný klíč, který se nikdy nesmí dostat k modelu AI (tělem je heslo SMTP).
DELETE /v1/email-marketing/senders/{sender_id} — Odebrat odesílací spojení a jeho uložené heslo. Operace deleteEmailMarketingSender. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z AI asistenta: ano, prostřednictvím MCP.
POST /v1/email-marketing/senders/{sender_id}/verify — Ověřit funkčnost odesílacího spojení, aniž by se cokoli odeslalo. Operace verifyEmailMarketingSender. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z AI asistenta: ano, prostřednictvím MCP.
PUT /v1/email-marketing/senders/{sender_id}/webhook — Uložit podpisový tajný klíč webhooku Vašeho poskytovatele e-mailu pro toto spojení. Operace setEmailMarketingSenderWebhook. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z AI asistenta: voláno jiným systémem (poskytovatelem nebo návštěvníkem), nikoli Vámi (ukládá tajný klíč webhooku poskytovatele).
SMS a WhatsApp
GET /v1/email-marketing/sms — Co obrazovka SMS vyžaduje — otevřeno?, pozastaveno?, zůstatek kreditu a ceny. Operace getEmailMarketingSms. Kontrolovaná oprávnění: email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
GET /v1/email-marketing/sms/campaigns — Hromadné SMS kampaně, od nejnovějších, jedna stránka keyset. Operace listSmsMarketingCampaigns. Kontrolovaná oprávnění: email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
POST /v1/email-marketing/sms/campaigns — Vytvoření konceptu SMS pro seznam. Operace createSmsMarketingCampaign. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
GET /v1/email-marketing/sms/campaigns/{campaign_id} — Jedna hromadná SMS kampaň. Operace getSmsMarketingCampaign. Kontrolovaná oprávnění: email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — Úprava konceptu (nebo odmítnuté kampaně, která se vrátí do stavu konceptu). Operace updateSmsMarketingCampaign. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — Čísla hromadné SMS kampaně. Operace getSmsMarketingCampaignReport. Kontrolovaná oprávnění: email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — Zahájit odesílání SMS všem na jejím seznamu, kteří vyjádřili souhlas se zasíláním SMS — nebo obnovit kampaň pozastavenou z důvodu kreditu. Operace sendSmsMarketingCampaign. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Od asistenta AI: Pouze rozhraní API a ovládací panel: spotřebovává peníze nebo kvótu, takže jej spouští osoba (odesílá placené zprávy SMS/WhatsApp).
GET /v1/email-marketing/sms/registrations/us — Registrace US 10DLC této organizace a její cena. Operace getEmailMarketingUsRegistration. Kontrolovaná oprávnění: email_marketing.view. Od asistenta AI: Ano, prostřednictvím MCP.
POST /v1/email-marketing/sms/registrations/us — Odeslat značku a kampaň této organizace pro registraci US 10DLC (poplatek se účtuje při odeslání). Operace submitEmailMarketingUsRegistration. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Od asistenta AI: Pouze rozhraní API a ovládací panel: spotřebovává peníze nebo kvótu, takže jej spouští osoba (registrace US 10DLC zahrnuje poplatky operátorům).
Kampaně prostřednictvím vaší vlastní e-mailové služby (šablony, segmenty, vyloučení)
GET /v1/campaigns — Kampaně dané organizace. Operace listCampaigns. Od asistenta AI: Ano, prostřednictvím MCP.
POST /v1/campaigns — Vytvořit kampaň ze šablony a publika. Operace createCampaign. Od asistenta AI: Ano, prostřednictvím MCP.
DELETE /v1/campaigns/esp — Odpojte účet poskytovatele a odstraňte jeho uložený klíč. Operace disconnectEsp. Z asistenta AI: Pouze API a řídicí panel: přenáší tajný údaj, který se nikdy nesmí dostat k modelu AI (zničí uložený klíč ESP).
GET /v1/campaigns/esp — Vlastní účet poskytovatele e-mailu dané organizace. Operace getEspConnection. Z asistenta AI: ano, prostřednictvím MCP.
POST /v1/campaigns/esp — Připojte účet poskytovatele e-mailu. Operace connectEsp. Z asistenta AI: Pouze API a řídicí panel: přenáší tajný údaj, který se nikdy nesmí dostat k modelu AI (tělo požadavku obsahuje klíč API ESP).
POST /v1/campaigns/esp/verify — Ověřte funkčnost účtu poskytovatele a načtěte jeho ověřené domény. Operace verifyEspConnection. Z asistenta AI: Pouze API a řídicí panel: přenáší tajný údaj, který se nikdy nesmí dostat k modelu AI (znovu zkontroluje uložený klíč ESP).
POST /v1/campaigns/preview — Render šablonu s ukázkovými hodnotami. Operace previewCampaignTemplate. Z asistenta AI: ano, prostřednictvím MCP.
GET /v1/campaigns/segments — Vaše uložené segmenty publika. Operace listCampaignSegments. Kontrolovaná oprávnění: campaigns.view. Z asistenta AI: ano, prostřednictvím MCP.
POST /v1/campaigns/segments — Uložte nový segment publika. Operace createCampaignSegment. Kontrolovaná oprávnění: campaigns.manage. Z asistenta AI: ano, prostřednictvím MCP.
GET /v1/campaigns/segments/fields — Slovník filtrů, jeho seznamy hodnot a magické značky. Operace getCampaignSegmentFields. Kontrolovaná oprávnění: campaigns.view. Z asistenta AI: ano, přes MCP.
POST /v1/campaigns/segments/preview — Kolik lidí toto osloví, kdo to je a koho to vynechává. Operace previewCampaignSegment. Kontrolovaná oprávnění: campaigns.view. Z asistenta AI: ano, přes MCP.
DELETE /v1/campaigns/segments/{segmentId} — Archivovat segment. Operace archiveCampaignSegment. Kontrolovaná oprávnění: campaigns.manage. Z asistenta AI: ano, přes MCP.
GET /v1/campaigns/segments/{segmentId} — Jeden uložený segment. Operace getCampaignSegment. Kontrolovaná oprávnění: campaigns.view. Z asistenta AI: ano, přes MCP.
PATCH /v1/campaigns/segments/{segmentId} — Přejmenovat segment nebo změnit jeho filtry. Operace updateCampaignSegment. Kontrolovaná oprávnění: campaigns.manage. Z asistenta AI: ano, přes MCP.
GET /v1/campaigns/suppressions — Adresy, které nesmí dostávat marketingová sdělení. Operace listCampaignSuppressions. Kontrolovaná oprávnění: campaigns.view. Z asistenta AI: ano, přes MCP.
POST /v1/campaigns/suppressions — Přidat adresu do seznamu potlačení. Operace createCampaignSuppression. Kontrolovaná oprávnění: campaigns.manage. Z asistenta AI: ano, přes MCP.
GET /v1/campaigns/tags — Paleta dynamických značek (magic tags), kterou editor kampaní nabízí. Operace listCampaignTags. Z AI asistenta: ano, prostřednictvím MCP.
GET /v1/campaigns/templates — Šablony kampaní organizace. Operace listCampaignTemplates. Z AI asistenta: ano, prostřednictvím MCP.
POST /v1/campaigns/templates — Vytvořit šablonu kampaně. Operace createCampaignTemplate. Z AI asistenta: ano, prostřednictvím MCP.
DELETE /v1/campaigns/templates/{templateId} — Archivovat šablonu a vyřadit její zdroje překladů. Operace archiveCampaignTemplate. Z AI asistenta: ano, prostřednictvím MCP.
GET /v1/campaigns/templates/{templateId} — Jedna šablona kampaně. Operace getCampaignTemplate. Z AI asistenta: ano, prostřednictvím MCP.
PUT /v1/campaigns/templates/{templateId} — Upravit šablonu kampaně. Operace updateCampaignTemplate. Z AI asistenta: ano, prostřednictvím MCP.
POST /v1/campaigns/unsubscribe — Odhlásit se z marketingového seznamu. Není vyžadován žádný účet. Operace unsubscribeFromCampaigns. Z AI asistenta: pouze API a administrační nástěnka: nese tajný klíč, který se nikdy nesmí dostat k modelu AI (přijímá podepsaný token pro odhlášení příjemce).
DELETE /v1/campaigns/{campaignId} — Smazat kampaň a vyřadit její záznamy o doručení. Operace deleteCampaign. Z AI asistenta: pouze API a administrační nástěnka: vyžaduje oprávnění, které AI připojením není nabízeno (smazání ESP kampaně vyžaduje campaigns.send).
GET /v1/campaigns/{campaignId} — Jedna kampaň a její zpráva o doručení. Operace getCampaign. Od asistenta AI: ano, prostřednictvím MCP.
POST /v1/campaigns/{campaignId}/control — Pozastavení, obnovení nebo zrušení probíhajícího odesílání. Operace controlCampaign. Od asistenta AI: pouze rozhraní API a ovládací panel: čerpá finance nebo limit, takže jej musí stisknout člověk (pozastavuje/obnovuje živé odesílání).
POST /v1/campaigns/{campaignId}/send — Zahájení trvalého odesílání. Operace sendCampaign. Od asistenta AI: pouze rozhraní API a ovládací panel: čerpá finance nebo limit, takže jej musí stisknout člověk (odesílá kampaň ESP skutečným příjemcům).
POST /v1/campaigns/{campaignId}/test — Odeslání jedné skutečné zprávy v kanálu, který bude kampaň skutečně používat. Operace testSendCampaign. Od asistenta AI: pouze rozhraní API a ovládací panel: vyžaduje oprávnění, která nejsou připojením AI nabízena (zkušební odeslání ESP vyžaduje campaigns.send).
Veřejné stránky a příchozí webhooky
GET /v1/public/email-marketing/c/{token} — Počítadlo kliknutí. Zaznamená jedno kliknutí na příjemce a přesměruje na původní odkaz. Operace emailMarketingClick. Od asistenta AI: stránka, kterou Vaši příjemci otevřou z e-mailu (přesměrování sledující kliknutí).
GET /v1/public/email-marketing/f/{public_id} — Hostovaná stránka registračního formuláře (bez přihlášení). Operace emailMarketingFormPage. Od asistenta AI: stránka, kterou Vaši příjemci otevřou z e-mailu (veřejná stránka registračního formuláře).
POST /v1/public/email-marketing/f/{public_id} — Odeslat registrační formulář (hostovaná stránka, vložení nebo JSON). Operace emailMarketingFormSubmit. Od asistenta AI: voláno jiným systémem (poskytovatelem nebo návštěvníkem), nikoli Vámi (návštěvník odešle registrační formulář).
GET /v1/public/email-marketing/fc — Stránka pro potvrzení dvojitého přihlášení (double opt-in) (bez přihlášení). Operace emailMarketingFormConfirmPage. Od asistenta AI: stránka, kterou Vaši příjemci otevřou z e-mailu (stránka pro potvrzení dvojitého přihlášení).
POST /v1/public/email-marketing/fc — Potvrdit registraci (přidá osobu do seznamu se záznamem o souhlasu). Operace emailMarketingFormConfirm. Od asistenta AI: voláno jiným systémem (poskytovatelem nebo návštěvníkem), nikoli Vámi (návštěvník potvrdí dvojité přihlášení).
GET /v1/public/email-marketing/o/{token} — Obrázek pro sledování otevření (GIF 1x1). Započítává jedno otevření na příjemce. Operace emailMarketingOpenPixel. Od asistenta AI: stránka, kterou Vaši příjemci otevřou z e-mailu (pixel pro sledování otevření).
GET /v1/public/email-marketing/u/{token} — Odkaz pro odhlášení odběru v zápatí (bez přihlášení). Operace emailMarketingUnsubscribePage. Od asistenta AI: stránka, kterou Vaši příjemci otevřou z e-mailu (stránka pro odhlášení odběru).
POST /v1/public/email-marketing/u/{token} — odhlášení jedním kliknutím dle RFC 8058 (a tlačítko stránky „zastavit vše“). Operace emailMarketingUnsubscribeOneClick. Od asistenta AI: voláno jiným systémem (poskytovatelem nebo návštěvníkem), nikoli vámi (odhlášení jedním kliknutím dle RFC 8058).
GET /v1/public/email-marketing/warmup-u/{token} — odkaz pro odhlášení z e-mailu pro zahřívání marketingového fondu (bez přihlášení). Operace emailMarketingWarmupUnsubscribePage. Od asistenta AI: stránka, kterou vaši příjemci otevřou z e-mailu (stránka pro odhlášení ze zahřívání).
POST /v1/public/email-marketing/warmup-u/{token} — odhlášení jedním kliknutím dle RFC 8058 ze zahřívacího e-mailu. Operace emailMarketingWarmupUnsubscribeOneClick. Od asistenta AI: voláno jiným systémem (poskytovatelem nebo návštěvníkem), nikoli vámi (odhlášení ze zahřívání jedním kliknutím).
POST /v1/webhooks/campaign-events — příjem podepsané události o doručení od poskytovatele e-mailových služeb. Operace receiveCampaignDeliveryWebhook. Od asistenta AI: voláno jiným systémem (poskytovatelem nebo návštěvníkem), nikoli vámi (podepsaný webhook doručení od ESP).
POST /v1/webhooks/campaigns/telnyx — příchozí odpovědi SMS (STOP / START) od našeho dodavatele SMS. Operace receiveCampaignsTelnyxInbound. Od asistenta AI: voláno jiným systémem (poskytovatelem nebo návštěvníkem), nikoli vámi (podepsaný příchozí webhook Telnyx).
POST /v1/webhooks/email-marketing/{connection_id} — Události doručení vlastního poskytovatele e-mailu zákazníka pro jedno připojení odesílání. Operace receiveEmailMarketingProviderWebhook. Z pohledu asistenta AI: voláno jiným systémem (poskytovatelem nebo návštěvníkem), nikoli vámi (podepsaný webhook poskytovatele odesílatele).
Toky
GET /v1/email-marketing/flows — E-mailové toky (uvítací, drip, roční datum), jedna stránka keyset. Operace listEmailMarketingFlows. Kontrolovaná oprávnění: email_marketing.view. Z pohledu asistenta AI: ano, prostřednictvím MCP.
POST /v1/email-marketing/flows — Vytvoření toku (začíná jako koncept). Operace createEmailMarketingFlow. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z pohledu asistenta AI: ano, prostřednictvím MCP.
DELETE /v1/email-marketing/flows/{flow_id} — Smazání toku a jeho zápisů (odeslaná spuštění zůstanou zachována jako kampaně). Operace deleteEmailMarketingFlow. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z pohledu asistenta AI: ano, prostřednictvím MCP.
GET /v1/email-marketing/flows/{flow_id} — Jeden tok s jeho kroky a přehledem (zapsáno, probíhá, spuštění a příjemci na krok). Operace getEmailMarketingFlow. Kontrolovaná oprávnění: email_marketing.view. Z pohledu asistenta AI: ano, prostřednictvím MCP.
PATCH /v1/email-marketing/flows/{flow_id} — Změna toku; parametr steps, je-li zadán, nahradí celou sekvenci. Operace updateEmailMarketingFlow. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
POST /v1/email-marketing/flows/{flow_id}/activate — Zapnutí toku; zařazeni budou pouze lidé, kteří se do seznamu připojí od této chvíle. Operace activateEmailMarketingFlow. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.
POST /v1/email-marketing/flows/{flow_id}/pause — Pozastavení toku; naplánované kroky čekají a nikomu novému se neodesílají e-maily, dokud nebude tok znovu zapnut. Operace pauseEmailMarketingFlow. Kontrolovaná oprávnění: email_marketing.manage, email_marketing.view. Z asistenta AI: ano, prostřednictvím MCP.