Mindent, amit a vezérlőpulton megtehet a Zinn® Campaigns szolgáltatásban, megtehet az API-n keresztül is, és a legtöbbjét egy, a fiókjához MCP-n keresztül csatlakoztatott AI-asszisztensből is elvégezheti. Ez az útmutató ismerteti a bejelentkezést, az engedélyeket, egy részletes példát mindkét módszerre, a korlátokat, a hibákat és mind a 89 Campaigns műveletet. Az alábbi műveletlista az API-specifikációnkból jön létre, így mindig pontosan megfelel az API működésének. Minden egyes művelet összes mezője megtalálható az API-referenciában a zinndigital.com/developers/api/zinn-campaigns címen.
Bejelentkezés
- API-kulcsok. Hozzon létre egy kulcsot a vezérlőpulton a Beállítások → API-kulcsok menüpontban, és küldje el a következő formátumban:
Authorization: Bearer zdk_live_… (egy zdk_test_… kulcs tesztkörnyezeti módban működik). Csak a szükséges Campaigns jogosultságokat adja meg a kulcsnak, és semmi többet.
- MI-asszisztensek (MCP). Csatlakoztassa a Claude, ChatGPT, Cursor vagy bármely MCP-klienst a
https://api.zinndigital.com/v1/mcp címhez az alkalmazásból való bejelentkezéssel vagy egy csatlakozási tokennel (zmcp_live_…). Lásd a Claude, Cursor vagy ChatGPT csatlakoztatása a fiókjához című részt. A hozzájárulási képernyőn jelölje be a Zinn® Campaigns jogosultságokat.
- Jogosultságok. Az
email_marketing.view olvassa a kampányokat, listákat, névjegyeket, űrlapokat, feladókat, SMS-beállításokat és jelentéseket; az email_marketing.manage létrehozza és módosítja őket. A saját e-mail szolgáltatásán keresztül küldött kampányok a campaigns.view és a campaigns.manage jogosultságokat használják.
- Viszonteladók. Adja át az
org_id paramétert az egyik ügyfélszervezeten való műveletvégzéshez. Hagyja el, ha a kulcsa vagy kapcsolata pontosan egy szervezethez fér hozzá.
Példa: vázlatos kampány létrehozása az API-val
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"
}'
A válasz 201 a piszkozattal. Tesztelje a POST /v1/email-marketing/campaigns/{campaign_id}/test használatával, ellenőrizze a GET /v1/email-marketing/campaigns/{campaign_id}/lint használatával, és küldje el a POST /v1/email-marketing/campaigns/{campaign_id}/send használatával.
Példa: ugyanaz a piszkozat egy MI-asszisztenstől
Kérje meg asszisztensét egyszerű szavakkal, például: "készíts egy Zinn® Campaigns e-mail piszkozatot Tavaszi vásár néven, 'A tavaszi vásárunk ma kezdődik' tárggyal". A háttérben megkeresi a műveletet az api_operations_search segítségével, beolvassa a paramétereit az api_operation_get segítségével, és futtatja azt az api_operation_call segítségével:
{
"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"
}
}
}
}
Amit az asszisztens nem tesz meg. Minden olyan művelet, amely üzenetet küld a címzettjeinek, vagy pénzt, illetve keretet fogyaszt — kampány küldése, SMS- vagy WhatsApp-üzenetek küldése, írás AI-kreditekkel, regisztráció US SMS-szolgáltatásra —, meg van tagadva az asszisztenstől, így egy félreértett utasítás soha nem juthat el az ügyfeleihez. Az asszisztens előkészíti a piszkozatot; Ön nyomja meg a Küldés gombot az irányítópulton, vagy hívja meg az API-t saját maga. A titkos adatok, mint például az SMTP-jelszó, szintén soha nem haladnak át az asszisztensen: adja meg őket az irányítópulton.
Korlátok
- 1200 kérés percenként személyenként vagy API-kulcsonként, és 6000 kérés percenként szervezetenként. A kettő közül a szigorúbb érvényes.
- 600 kérés percenként minden egyes MCP-kapcsolathoz.
- A korlát túllépése esetén a válasz
429, egy Retry-After fejléccel: várjon ennyi másodpercet.
- A listatagok hozzáadása kérésenként legfeljebb 1000 címet fogad el; a csomagja kontakt- és e-mail-kerete mindenre vonatkozik, amit az API-n keresztül végez.
Hibák
Minden hiba azonos szerkezetű:
{"error": {"code": "UNPROCESSABLE_ENTITY", "message": "…", "details": [{"field": "subject", "code": "REQUIRED", "message": "…"}], "request_id": "…"}}
A code soha nem változik ugyanazon probléma esetén, ezért ezt tesztelje a message helyett. Adja meg a request_id azonosítót, amikor kapcsolatba lép az ügyfélszolgálattal. A válaszok, amelyekkel találkozni fog: 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 CONFLICT, 422 UNPROCESSABLE_ENTITY, 429 TOO_MANY_REQUESTS. A 403 azt jelenti, hogy a kulcs vagy a kapcsolat nem rendelkezik az alábbi listában megnevezett engedéllyel; a 404 olyan elemre is vonatkozik egy szervezetben, amelyet Ön nem láthat; a 422 felsorol minden hibás mezőt a details részben; 429 után várjon a Retry-After fejlécben szereplő másodpercig.
Webhookok
A kézbesítési eredmények az Ön e-mailjét küldő szolgáltatótól érkeznek be a Zinn® Campaigns rendszerbe:
- Saját szolgáltató esetén (például Resend) tárolja annak webhook-aláíró titkos kulcsát a küldési kapcsolaton a vezérlőpulton (Campaigns → Sending). Kap egy
webhook_url címet; irányítsa rá a szolgáltató delivered, bounced és complained eseményeit. A visszapattanás vagy a spampanasz azonnal eltávolítja a címet a jövőbeli küldésekből.
- Zinn® küldés esetén semmit sem kell beállítani.
Olvassa el az eredményeket a jelentéskészítési műveletekkel (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).
Minden Campaigns művelet
Áttekintés
GET /v1/email-marketing — Zinn® Campaigns áttekintés egy szervezet számára. getEmailMarketingOverview művelet. Ellenőrzött engedélyek: email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
E-mail-kampányok
GET /v1/email-marketing/campaigns — E-mail kampányok, a legújabbak elöl, egy keyset oldal. Művelet: listEmailMarketingCampaigns. Ellenőrzött jogosultságok: email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/email-marketing/campaigns — E-mail kampányvázlat létrehozása. Művelet: createEmailMarketingCampaign. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
GET /v1/email-marketing/campaigns/{campaign_id} — Egy e-mail kampány. Művelet: getEmailMarketingCampaign. Ellenőrzött jogosultságok: email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
PATCH /v1/email-marketing/campaigns/{campaign_id} — Vázlat szerkesztése (vagy egy elutasított kampányé, amely visszatér a vázlat állapotba). Művelet: updateEmailMarketingCampaign. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
GET /v1/email-marketing/campaigns/{campaign_id}/lint — A kampány szövegének ellenőrzése kézbesíthetőségi problémák szempontjából a kiküldés előtt. Művelet: lintEmailMarketingCampaign. Ellenőrzött jogosultságok: email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
GET /v1/email-marketing/campaigns/{campaign_id}/report — Egy kampány számai. Művelet: getEmailMarketingCampaignReport. Ellenőrzött jogosultságok: email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/email-marketing/campaigns/{campaign_id}/send — Kampány küldésének elindítása a listájára. Művelet: sendEmailMarketingCampaign. Ellenőrzött engedélyek: email_marketing.manage, email_marketing.view. MI-asszisztenstől: csak API és vezérlőpult: pénzbe vagy keretbe kerül, ezért egy személy nyomja meg (valódi címzetteknek küldi el, és fogyasztja a keretet).
POST /v1/email-marketing/campaigns/{campaign_id}/test — Egy tesztpéldány küldése most a szervezet egyik tagjának. Művelet: testEmailMarketingCampaign. Ellenőrzött engedélyek: email_marketing.manage, email_marketing.view. MI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/email-marketing/campaigns/{campaign_id}/translate — Egy kampány lefordítása minden olyan kapcsolattartási nyelvre, amely hiányzik vagy elavult. Művelet: translateEmailMarketingCampaign. Ellenőrzött engedélyek: email_marketing.manage, email_marketing.view. MI-asszisztenstől: igen, az MCP-n keresztül.
GET /v1/email-marketing/campaigns/{campaign_id}/translations — A kampány listájának összes kapcsolattartási nyelve, és hogy a fordításuk naprakész-e. Művelet: listEmailMarketingCampaignTranslations. Ellenőrzött engedélyek: email_marketing.view. MI-asszisztenstől: igen, az MCP-n keresztül.
Szövegírás MI-vel
POST /v1/email-marketing/ai/write — Piszkozat kampány-e-mail írása rövid összefoglalóból a Zinn® AI segítségével. writeEmailMarketingCampaignWithAi művelet. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. AI-asszisztensből: csak API és irányítópult: pénzt vagy keretet fogyaszt, ezért ember nyomja meg (az AI-írás AI-krediteket fogyaszt).
Márkakészlet
GET /v1/email-marketing/brand-kit — A szervezet márkakészlete (név, logó, színek, betűtípus, hangvétel). getEmailMarketingBrandKit művelet. Ellenőrzött jogosultságok: email_marketing.view. AI-asszisztensből: igen, az MCP-n keresztül.
PUT /v1/email-marketing/brand-kit — A márkakészlet szerkesztése. updateEmailMarketingBrandKit művelet. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. AI-asszisztensből: igen, az MCP-n keresztül.
POST /v1/email-marketing/brand-kit/read — A márkakészlet beolvasása a szervezet webhelyéről. readEmailMarketingBrandKit művelet. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. AI-asszisztensből: igen, az MCP-n keresztül.
Kapcsolatok és egyszeri üzenetek
GET /v1/email-marketing/contacts — A szervezet kapcsolatai, egyszerre egy kulcskészlet-oldal. listEmailMarketingContacts művelet. Ellenőrzött jogosultságok: email_marketing.view. MI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/email-marketing/contacts/{contact_id}/messages — Egyetlen SMS küldése egyetlen kapcsolattartónak, a Zinn® kreditegyenlegből fizetve. sendEmailMarketingMessage művelet. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. MI-asszisztenstől: csak API és irányítópult: pénzt vagy keretet fogyaszt, ezért ember nyomja meg (egy kapcsolattartónak küldött egyszeri üzenet keretet fogyaszt).
GET /v1/email-marketing/messages — A szervezet által elküldött SMS- és WhatsApp-üzenetek, a legújabbak elöl, egy kulcskészlet-oldal. listEmailMarketingMessages művelet. Ellenőrzött jogosultságok: email_marketing.view. MI-asszisztenstől: igen, az MCP-n keresztül.
Listák
GET /v1/email-marketing/lists — A szervezet levelezőlistái a feliratkozottak és leiratkozottak számával. Művelet: listEmailMarketingLists. Ellenőrzött jogosultságok: email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/email-marketing/lists — Levelezőlista létrehozása (vagy az adott nevű visszaadása). Művelet: createEmailMarketingList. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/email-marketing/lists/{list_id}/members — Kapcsolatok hozzáadása a listához e-mail-cím alapján (kérésenként legfeljebb 1000). Művelet: addEmailMarketingListMembers. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
Importálások
GET /v1/email-marketing/imports — Korábbi kapcsolatimportálások, a legújabbak elöl, egyszerre egy keyset-oldal. Művelet: listEmailMarketingImports. Ellenőrzött jogosultságok: email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/email-marketing/imports — Kapcsolatok egy csoportjának importálása a hozzájárulási igazolással együtt. Művelet: createEmailMarketingImport. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
Feliratkozási űrlapok
GET /v1/email-marketing/forms — Feliratkozási űrlapok (kettős feliratkozás), a legújabbak elöl, egy keyset oldal. Művelet: listEmailMarketingForms. Ellenőrzött jogosultságok: email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/email-marketing/forms — Hozzon létre egy feliratkozási űrlapot, amely megerősített személyeket ad hozzá egy listához. Művelet: createEmailMarketingForm. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
DELETE /v1/email-marketing/forms/{form_id} — Töröljön egy feliratkozási űrlapot (a már megerősített személyek a listán maradnak). Művelet: deleteEmailMarketingForm. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
PATCH /v1/email-marketing/forms/{form_id} — Módosítson egy feliratkozási űrlapot (megfogalmazás, lista, átirányítás, be vagy ki). Művelet: updateEmailMarketingForm. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
Küldési kapcsolatok
GET /v1/email-marketing/senders — A szervezet küldési kapcsolatai. listEmailMarketingSenders művelet. Ellenőrzött jogosultságok: email_marketing.view. MI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/email-marketing/senders — Kampányfeladó csatlakoztatása (Zinn® küldés vagy az ügyfél saját SMTP-kiszolgálója). createEmailMarketingSender művelet. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. MI-asszisztenstől: csak API és vezérlőpult: olyan titkos adatot hordoz, amely soha nem juthat el egy MI-modellhez (a törzs az SMTP-jelszó).
DELETE /v1/email-marketing/senders/{sender_id} — Küldési kapcsolat és a tárolt jelszavának eltávolítása. deleteEmailMarketingSender művelet. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. MI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/email-marketing/senders/{sender_id}/verify — Annak igazolása, hogy a küldési kapcsolat működik, bármi elküldése nélkül. verifyEmailMarketingSender művelet. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. MI-asszisztenstől: igen, az MCP-n keresztül.
PUT /v1/email-marketing/senders/{sender_id}/webhook — Az e-mail szolgáltató webhook-aláírási titkának tárolása ehhez a kapcsolathoz. setEmailMarketingSenderWebhook művelet. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. MI-asszisztenstől: egy másik rendszer hívja meg (egy szolgáltató vagy egy látogató), nem Ön (a szolgáltató webhook-titkát tárolja).
SMS és WhatsApp
GET /v1/email-marketing/sms — Amire az SMS képernyőnek szüksége van — nyitott?, szüneteltetve?, kreditegyenleg és árak. Művelet: getEmailMarketingSms. Ellenőrzött jogosultságok: email_marketing.view. AI-asszisztensből: igen, az MCP-n keresztül.
GET /v1/email-marketing/sms/campaigns — Tömeges SMS-kampányok, a legújabbak elöl, egy keyset oldal. Művelet: listSmsMarketingCampaigns. Ellenőrzött jogosultságok: email_marketing.view. AI-asszisztensből: igen, az MCP-n keresztül.
POST /v1/email-marketing/sms/campaigns — SMS-piszkozat létrehozása egy listához. Művelet: createSmsMarketingCampaign. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. AI-asszisztensből: igen, az MCP-n keresztül.
GET /v1/email-marketing/sms/campaigns/{campaign_id} — Egyetlen tömeges SMS-kampány. Művelet: getSmsMarketingCampaign. Ellenőrzött jogosultságok: email_marketing.view. AI-asszisztensből: igen, az MCP-n keresztül.
PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — Piszkozat szerkesztése (vagy egy elutasított kampányé, amely visszatér a piszkozatok közé). Művelet: updateSmsMarketingCampaign. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. AI-asszisztensből: igen, az MCP-n keresztül.
GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — Egy tömeges SMS-kampány számai. Művelet: getSmsMarketingCampaignReport. Ellenőrzött jogosultságok: email_marketing.view. AI-asszisztensből: igen, az MCP-n keresztül.
POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — SMS küldésének indítása a listán szereplő mindazon személyeknek, akik hozzájárultak az SMS-ek fogadásához — vagy egy egyenleghiány miatt szüneteltetett küldés folytatása. Művelet: sendSmsMarketingCampaign. Ellenőrzött engedélyek: email_marketing.manage, email_marketing.view. AI-asszisztenstől: Kizárólag API és vezérlőpult: pénzt vagy keretet használ fel, ezért emberi jóváhagyást (gombnyomást) igényel (fizetős SMS/WhatsApp üzeneteket küld).
GET /v1/email-marketing/sms/registrations/us — A szervezet US 10DLC regisztrációja, és annak költsége. Művelet: getEmailMarketingUsRegistration. Ellenőrzött engedélyek: email_marketing.view. AI-asszisztenstől: Igen, az MCP-n keresztül.
POST /v1/email-marketing/sms/registrations/us — A szervezet márkájának és kampányának beküldése a US 10DLC regisztrációhoz (a beküldéskor fizetendő). Művelet: submitEmailMarketingUsRegistration. Ellenőrzött engedélyek: email_marketing.manage, email_marketing.view. AI-asszisztenstől: Kizárólag API és vezérlőpult: pénzt vagy keretet használ fel, ezért emberi jóváhagyást (gombnyomást) igényel (a US 10DLC regisztráció hálózati díjakkal jár).
Kampányok az Ön saját e-mail szolgáltatásán keresztül (sablonok, szegmensek, kizárások)
GET /v1/campaigns — A szervezet kampányai. Művelet: listCampaigns. AI-asszisztenstől: Igen, az MCP-n keresztül.
POST /v1/campaigns — Kampány létrehozása sablonból és közönségből. Művelet: createCampaign. AI-asszisztenstől: Igen, az MCP-n keresztül.
DELETE /v1/campaigns/esp — A szolgáltatói fiók leválasztása és a tárolt kulcs eltávolítása. Művelet: disconnectEsp. AI-asszisztenstől: csak API és vezérlőpult: olyan titkos adatot tartalmaz, amely soha nem juthat el egy AI-modellhez (megsemmisíti a tárolt ESP-kulcsot).
GET /v1/campaigns/esp — A szervezet saját e-mail-szolgáltatói fiókja. Művelet: getEspConnection. AI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/campaigns/esp — E-mail-szolgáltatói fiók csatlakoztatása. Művelet: connectEsp. AI-asszisztenstől: csak API és vezérlőpult: olyan titkos adatot tartalmaz, amely soha nem juthat el egy AI-modellhez (a törzs maga az ESP API-kulcs).
POST /v1/campaigns/esp/verify — Annak ellenőrzése, hogy a szolgáltatói fiók működik-e, valamint az ellenőrzött domainek beolvasása. Művelet: verifyEspConnection. AI-asszisztenstől: csak API és vezérlőpult: olyan titkos adatot tartalmaz, amely soha nem juthat el egy AI-modellhez (újraellenőrzi a tárolt ESP-kulcsot).
POST /v1/campaigns/preview — Sablon Renderelése példaértékekkel. Művelet: previewCampaignTemplate. AI-asszisztenstől: igen, az MCP-n keresztül.
GET /v1/campaigns/segments — Az Ön mentett célközönség-szegmensei. Művelet: listCampaignSegments. Ellenőrzött jogosultságok: campaigns.view. AI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/campaigns/segments — Új célközönség-szegmens mentése. Művelet: createCampaignSegment. Ellenőrzött jogosultságok: campaigns.manage. AI-asszisztenstől: igen, az MCP-n keresztül.
GET /v1/campaigns/segments/fields — A szűrőszótár, annak értéklistái és a varázscímkék. Művelet: getCampaignSegmentFields. Ellenőrzött jogosultságok: campaigns.view. MI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/campaigns/segments/preview — Hány embert ér el, kik ők, és kiket hagy ki. Művelet: previewCampaignSegment. Ellenőrzött jogosultságok: campaigns.view. MI-asszisztenstől: igen, az MCP-n keresztül.
DELETE /v1/campaigns/segments/{segmentId} — Szegmens archiválása. Művelet: archiveCampaignSegment. Ellenőrzött jogosultságok: campaigns.manage. MI-asszisztenstől: igen, az MCP-n keresztül.
GET /v1/campaigns/segments/{segmentId} — Egy mentett szegmens. Művelet: getCampaignSegment. Ellenőrzött jogosultságok: campaigns.view. MI-asszisztenstől: igen, az MCP-n keresztül.
PATCH /v1/campaigns/segments/{segmentId} — Szegmens átnevezése vagy szűrőinek módosítása. Művelet: updateCampaignSegment. Ellenőrzött jogosultságok: campaigns.manage. MI-asszisztenstől: igen, az MCP-n keresztül.
GET /v1/campaigns/suppressions — Címek, amelyek nem kaphatnak marketinganyagokat. Művelet: listCampaignSuppressions. Ellenőrzött jogosultságok: campaigns.view. MI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/campaigns/suppressions — Cím hozzáadása a letiltási listához. Művelet: createCampaignSuppression. Ellenőrzött jogosultságok: campaigns.manage. MI-asszisztenstől: igen, az MCP-n keresztül.
GET /v1/campaigns/tags — A kampányszerkesztő által kínált varázscímke-paletta. Művelet: listCampaignTags. MI-asszisztenstől: igen, az MCP-n keresztül.
GET /v1/campaigns/templates — A szervezet kampánysablonjai. Művelet: listCampaignTemplates. MI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/campaigns/templates — Kampánysablon létrehozása. Művelet: createCampaignTemplate. MI-asszisztenstől: igen, az MCP-n keresztül.
DELETE /v1/campaigns/templates/{templateId} — Sablon archiválása és fordítási forrásainak visszavonása. Művelet: archiveCampaignTemplate. MI-asszisztenstől: igen, az MCP-n keresztül.
GET /v1/campaigns/templates/{templateId} — Egyetlen kampánysablon. Művelet: getCampaignTemplate. MI-asszisztenstől: igen, az MCP-n keresztül.
PUT /v1/campaigns/templates/{templateId} — Kampánysablon szerkesztése. Művelet: updateCampaignTemplate. MI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/campaigns/unsubscribe — Leiratkozás a marketinglistáról. Nincs szükség fiókra. Művelet: unsubscribeFromCampaigns. MI-asszisztenstől: Csak API és vezérlőpult: olyan titkos adatot tartalmaz, amely soha nem juthat el egy MI-modellhez (a címzett aláírt leiratkozási tokenjét igényli).
DELETE /v1/campaigns/{campaignId} — Kampány törlése és a kézbesítési sorainak visszavonása. Művelet: deleteCampaign. MI-asszisztenstől: Csak API és vezérlőpult: olyan engedélyt igényel, amelyet az MI-kapcsolatok nem kapnak meg (egy ESP-kampány törléséhez campaigns.send szükséges).
GET /v1/campaigns/{campaignId} — Egy kampány és a kézbesítési jelentése. Művelet: getCampaign. AI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/campaigns/{campaignId}/control — Folyamatban lévő küldés szüneteltetése, folytatása vagy megszakítása. Művelet: controlCampaign. AI-asszisztenstől: csak API és vezérlőpult: pénzbe vagy keretbe kerül, ezért ember nyomja meg (élő küldést szüneteltet/folytat).
POST /v1/campaigns/{campaignId}/send — A tartós küldés elindítása. Művelet: sendCampaign. AI-asszisztenstől: csak API és vezérlőpult: pénzbe vagy keretbe kerül, ezért ember nyomja meg (ESP-kampányt küld valós címzetteknek).
POST /v1/campaigns/{campaignId}/test — Egy valódi üzenet küldése azon a csatornán, amelyet a kampány ténylegesen használni fog. Művelet: testSendCampaign. AI-asszisztenstől: csak API és vezérlőpult: olyan jogosultság szükséges hozzá, amellyel az AI-kapcsolatok nem rendelkeznek (az ESP-tesztküldéshez a campaigns.send szükséges).
Nyilvános oldalak és bejövő webhookok
GET /v1/public/email-marketing/c/{token} — A kattintásszámláló. Címzettenként egy kattintást rögzít, és átirányít az eredeti hivatkozásra. Művelet: emailMarketingClick. AI-asszisztenstől: egy oldal, amelyet a címzettjei egy e-mailből nyitnak meg (a kattintáskövető átirányítás).
GET /v1/public/email-marketing/f/{public_id} — Egy feliratkozási űrlap tárhelyen lévő oldala (bejelentkezés nélkül). Művelet: emailMarketingFormPage. AI-asszisztenstől: egy oldal, amelyet a címzettjei egy e-mailből nyitnak meg (a nyilvános feliratkozási űrlap oldala).
POST /v1/public/email-marketing/f/{public_id} — Regisztrációs űrlap beküldése (tárhelyen lévő oldal, beágyazás vagy JSON). Művelet: emailMarketingFormSubmit. Egy MI-asszisztenstől: egy másik rendszer (szolgáltató vagy látogató) hívja meg, nem Ön (egy látogató regisztrációs űrlapot küld be).
GET /v1/public/email-marketing/fc — A kettős feliratkozást (double opt-in) megerősítő oldal (bejelentkezés nélkül). Művelet: emailMarketingFormConfirmPage. Egy MI-asszisztenstől: egy oldal, amelyet a címzettjei egy e-mailből nyitnak meg (a kettős feliratkozást megerősítő oldal).
POST /v1/public/email-marketing/fc — Regisztráció megerősítése (hozzáadja a személyt a listához a beleegyezés rögzítésével). Művelet: emailMarketingFormConfirm. Egy MI-asszisztenstől: egy másik rendszer (szolgáltató vagy látogató) hívja meg, nem Ön (egy látogató megerősíti a kettős feliratkozást).
GET /v1/public/email-marketing/o/{token} — Megnyitáskövető kép (egy 1x1-es GIF). Címzettenként egy megnyitást számlál. Művelet: emailMarketingOpenPixel. Egy MI-asszisztenstől: egy oldal, amelyet a címzettjei egy e-mailből nyitnak meg (a megnyitáskövető képpont).
GET /v1/public/email-marketing/u/{token} — Lábléc leiratkozási hivatkozás (bejelentkezés nélkül). Művelet: emailMarketingUnsubscribePage. Egy MI-asszisztenstől: egy oldal, amelyet a címzettjei egy e-mailből nyitnak meg (a leiratkozási oldal).
POST /v1/public/email-marketing/u/{token} — RFC 8058 egykattintásos leiratkozás (és az oldal „minden leállítása” gombja). emailMarketingUnsubscribeOneClick művelet. Egy MI-asszisztenstől: egy másik rendszer (szolgáltató vagy látogató) hívja meg, nem Ön (RFC 8058 egykattintásos leiratkozás).
GET /v1/public/email-marketing/warmup-u/{token} — A marketingkészlet bemelegítő levelének leiratkozási linkje (bejelentkezés nélkül). emailMarketingWarmupUnsubscribePage művelet. Egy MI-asszisztenstől: egy oldal, amelyet a címzettek egy e-mailből nyitnak meg (a bemelegítő leiratkozási oldal).
POST /v1/public/email-marketing/warmup-u/{token} — RFC 8058 egykattintásos leiratkozás a bemelegítő levélből. emailMarketingWarmupUnsubscribeOneClick művelet. Egy MI-asszisztenstől: egy másik rendszer (szolgáltató vagy látogató) hívja meg, nem Ön (bemelegítő egykattintásos leiratkozás).
POST /v1/webhooks/campaign-events — Aláírt kézbesítési esemény fogadása az e-mail-szolgáltatótól. receiveCampaignDeliveryWebhook művelet. Egy MI-asszisztenstől: egy másik rendszer (szolgáltató vagy látogató) hívja meg, nem Ön (aláírt ESP-kézbesítési webhook).
POST /v1/webhooks/campaigns/telnyx — Bejövő SMS-válaszok (STOP / START) az SMS-szolgáltatónktól. receiveCampaignsTelnyxInbound művelet. Egy MI-asszisztenstől: egy másik rendszer (szolgáltató vagy látogató) hívja meg, nem Ön (aláírt Telnyx bejövő webhook).
POST /v1/webhooks/email-marketing/{connection_id} — Az ügyfél saját e-mail szolgáltatójának kézbesítési eseményei egy küldési kapcsolathoz. Művelet: receiveEmailMarketingProviderWebhook. AI-asszisztenstől: egy másik rendszer (egy szolgáltató vagy egy látogató) hívja meg, nem Ön (aláírt feladó-szolgáltató webhook).
Flows
GET /v1/email-marketing/flows — E-mail folyamatok (üdvözlő, drip, éves dátum), egy kulcskészlet-oldal. Művelet: listEmailMarketingFlows. Ellenőrzött jogosultságok: email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/email-marketing/flows — Folyamat létrehozása (vázlatként indul). Művelet: createEmailMarketingFlow. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
DELETE /v1/email-marketing/flows/{flow_id} — Folyamat és feliratkozásai törlése (az elküldött lefutások megmaradnak kampányként). Művelet: deleteEmailMarketingFlow. Ellenőrzött jogosultságok: email_marketing.manage, email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
GET /v1/email-marketing/flows/{flow_id} — Egy folyamat a lépéseivel és jelentésével (feliratkozottak, folyamatban lévők, lefutások és címzettek lépésenként). Művelet: getEmailMarketingFlow. Ellenőrzött jogosultságok: email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
PATCH /v1/email-marketing/flows/{flow_id} — Folyamat módosítása; a megadott steps a teljes sorozatot felülírja. Művelet: updateEmailMarketingFlow. Ellenőrzött engedélyek: email_marketing.manage, email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/email-marketing/flows/{flow_id}/activate — Folyamat bekapcsolása; csak a listához mostantól csatlakozó személyek kerülnek beiratásra. Művelet: activateEmailMarketingFlow. Ellenőrzött engedélyek: email_marketing.manage, email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.
POST /v1/email-marketing/flows/{flow_id}/pause — Folyamat szüneteltetése; az esedékes lépések várakoznak, és senki új nem kap e-mailt a visszakapcsolásig. Művelet: pauseEmailMarketingFlow. Ellenőrzött engedélyek: email_marketing.manage, email_marketing.view. AI-asszisztenstől: igen, az MCP-n keresztül.