Çdo gjë që mund të bëni në Zinn® Campaigns në panelin e kontrollit, mund ta bëni gjithashtu përmes API-së, dhe shumicën e tyre nga një asistent AI i lidhur me llogarinë tuaj nëpërmjet MCP-së. Ky udhëzues mbulon hyrjen, lejet, një shembull të ilustruar për të dyja mënyrat, kufijtë, gabimet dhe secilin nga 89 veprimet e Campaigns. Lista e veprimeve më poshtë është gjeneruar nga specifikimi ynë i API-së, kështu që përputhet gjithmonë me atë që kryen API-ja. Çdo fushë e çdo veprimi gjendet në referencën e API-së në zinndigital.com/developers/api/zinn-campaigns.
Hyrja
- Çelësat e API-t. Krijoni një çelës në panelin e kontrollit te Parametrat → Çelësat e API-t dhe dërgojeni atë si
Authorization: Bearer zdk_live_… (një çelës zdk_test_… funksionon në modalitetin sandbox). Jepini çelësit vetëm lejet e Campaigns që i nevojiten dhe asgjë më shumë.
- Asistentët e AI-së (MCP). Lidhni Claude, ChatGPT, Cursor ose çdo klient MCP me
https://api.zinndigital.com/v1/mcp, ose duke u kyçur nga aplikacioni, ose me një token lidhjeje (zmcp_live_…). Shikoni Lidhja e Claude, Cursor ose ChatGPT me llogarinë tuaj. Në ekranin e pëlqimit, shënoni lejet e Zinn® Campaigns.
- Lejet.
email_marketing.view lexon fushatat, listat, kontaktet, formularët, dërguesit, parametrat e SMS-ve dhe raportet; email_marketing.manage i krijon dhe i ndryshon ato. Fushatat që dërgoni përmes shërbimit tuaj të email-it përdorin campaigns.view dhe campaigns.manage.
- Rishitësit. Kaloni
org_id për të vepruar në një nga organizatat e klientëve tuaj. Lëreni bosh kur çelësi ose lidhja juaj i përket saktësisht vetëm një organizate.
Shembull: krijoni një draft fushate me API-n
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"
}'
Përgjigjja është 201 me draftin. Testojeni atë me POST /v1/email-marketing/campaigns/{campaign_id}/test, kontrollojeni me GET /v1/email-marketing/campaigns/{campaign_id}/lint, dhe dërgojeni me POST /v1/email-marketing/campaigns/{campaign_id}/send.
Shembull: i njëjti draft nga një asistent AI
Kërkojini asistentit tuaj me fjalë të thjeshta, për shembull "krijo një draft emaili të Zinn® Campaigns të quajtur Spring sale me temë 'Our spring sale starts today'". Në prapaskenë ai gjen veprimin me api_operations_search, lexon parametrat e tij me api_operation_get dhe e ekzekuton atë me 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"
}
}
}
}
Çfarë nuk do të bëjë një asistent. Çdo gjë që dërgon te marrësit tuaj ose shpenzon para apo kuota — dërgimi i një fushate, dërgimi i mesazheve SMS ose WhatsApp, shkrimi me kredite AI, regjistrimi për mesazhe me tekst në US — i refuzohet një asistenti, kështu që një udhëzim i keqkuptuar nuk mund të arrijë kurrë te klientët tuaj. Asistenti përgatit draftin; ju shtypni Dërgo në panelin e kontrollit ose thirrni vetë API-n. Sekretet, siç është një fjalëkalim SMTP, gjithashtu nuk kalohen kurrë përmes një asistenti: futini ato në panelin e kontrollit.
Limitet
- 1.200 kërkesa në minutë për çdo person ose çelës API, dhe 6.000 kërkesa në minutë për çdo organizatë. Zbatohet më i rrepti nga të dy.
- 600 kërkesa në minutë për çdo lidhje MCP.
- Mbi një limit, përgjigjja është
429 me një krye Retry-After: prisni aq sekonda.
- Shtimi i anëtarëve të listës merr më së shumti 1.000 adresa për kërkesë; kuotat e kontakteve dhe të emaileve të planit tuaj zbatohen për gjithçka që bëni përmes API-t.
Gabimet
Çdo gabim ka të njëjtën formë:
{"error": {"code": "UNPROCESSABLE_ENTITY", "message": "…", "details": [{"field": "subject", "code": "REQUIRED", "message": "…"}], "request_id": "…"}}
code nuk ndryshon kurrë për të njëjtin problem, prandaj testoni atë dhe jo message. Jepni request_id kur kontaktoni mbështetjen. Përgjigjet me të cilat do të përballeni: 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 CONFLICT, 422 UNPROCESSABLE_ENTITY, 429 TOO_MANY_REQUESTS. Një 403 do të thotë se çelësit ose lidhjes i mungon një leje që përmendet në listën e mëposhtme; një 404 mbulon gjithashtu diçka në një organizatë që nuk mund ta shihni; një 422 liston çdo fushë të gabuar në details; pas një 429, prisni numrin e sekondave të përcaktuar në kokën Retry-After.
Webhook-et
Rezultatet e dorëzimit vijnë te Zinn® Campaigns nga ofruesi që dërgon email-et tuaja:
- Me ofruesin tuaj (për shembull Resend), ruani sekretin e nënshkrimit të webhook-ut të tij në lidhjen e dërgimit te paneli kryesor (Fushatat → Dërgimi). Ju merrni një
webhook_url; drejtojini ngjarjet delivered, bounced dhe complained të ofruesit drejt tij. Një kthim mbrapsht ose një ankesë për spam e heq menjëherë adresën nga dërgimet e ardhshme.
- Me dërgimin e Zinn®, nuk ka asgjë për të konfiguruar.
Lexoni rezultatet me operacionet e raportimit (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).
Çdo operacion i Campaigns
Përmbledhje
GET /v1/email-marketing — Përmbledhja e Zinn® Campaigns për një organizatë. Operacioni getEmailMarketingOverview. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
Fushatat e email-it
GET /v1/email-marketing/campaigns — Fushatat e postës elektronike, më të rejat së pari, një faqe keyset. Veprimi listEmailMarketingCampaigns. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP.
POST /v1/email-marketing/campaigns — Krijoni një draft të fushatës së postës elektronike. Veprimi createEmailMarketingCampaign. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP.
GET /v1/email-marketing/campaigns/{campaign_id} — Një fushatë e postës elektronike. Veprimi getEmailMarketingCampaign. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP.
PATCH /v1/email-marketing/campaigns/{campaign_id} — Modifikoni një draft (ose një fushatë të refuzuar, e cila kthehet në draft). Veprimi updateEmailMarketingCampaign. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP.
GET /v1/email-marketing/campaigns/{campaign_id}/lint — Kontrolloni tekstin e një fushate për probleme të dërgimit përpara se të dërgohet. Veprimi lintEmailMarketingCampaign. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP.
GET /v1/email-marketing/campaigns/{campaign_id}/report — Shifrat e një fushate. Veprimi getEmailMarketingCampaignReport. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP.
POST /v1/email-marketing/campaigns/{campaign_id}/send — Filloni dërgimin e një fushate te lista e saj. Veprimi sendEmailMarketingCampaign. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: vetëm me API dhe panelin e kontrollit: shpenzon para ose sasi të caktuar, kështu që e shtyp një person (dërgon te marrës të vërtetë dhe shpenzon sasinë e lejuar).
POST /v1/email-marketing/campaigns/{campaign_id}/test — Dërgoni një kopje testuese tani te një anëtar i organizatës. Veprimi testEmailMarketingCampaign. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP.
POST /v1/email-marketing/campaigns/{campaign_id}/translate — Përktheni një fushatë në çdo gjuhë kontakti që mungon ose është e vjetruar. Veprimi translateEmailMarketingCampaign. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP.
GET /v1/email-marketing/campaigns/{campaign_id}/translations — Çdo gjuhë kontakti e listës së një fushate dhe nëse përkthimi i saj është aktual. Veprimi listEmailMarketingCampaignTranslations. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP.
Shkrimi me AI
POST /v1/email-marketing/ai/write — Shkruani një skicë emaili fushate nga një përmbledhje e shkurtër me Zinn® AI. Operacioni writeEmailMarketingCampaignWithAi. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: vetëm API dhe paneli: shpenzon para ose kuotë, kështu që e shtyp një person (shkrimi me AI shpenzon kredite AI).
Paketa e markës
GET /v1/email-marketing/brand-kit — Paketa e markës së organizatës (emri, logoja, ngjyrat, fonti, zëri). Operacioni getEmailMarketingBrandKit. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
PUT /v1/email-marketing/brand-kit — Modifikoni paketën e markës. Operacioni updateEmailMarketingBrandKit. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
POST /v1/email-marketing/brand-kit/read — Lexoni paketën e markës nga uebsajti i organizatës. Operacioni readEmailMarketingBrandKit. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
Kontaktet dhe mesazhet njëre herë
GET /v1/email-marketing/contacts — Kontaktet e organizatës, një faqe keyset në një kohë. Veprimi listEmailMarketingContacts. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP.
POST /v1/email-marketing/contacts/{contact_id}/messages — Dërgoni një SMS për një kontakt, i paguar nga bilanci i krediteve Zinn®. Veprimi sendEmailMarketingMessage. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: vetëm API dhe paneli i kontrollit: shpenzon para ose kuotë, prandaj e shtyp një person (një mesazh i vetëm për një kontakt shpenzon kuotë).
GET /v1/email-marketing/messages — Mesazhet SMS dhe WhatsApp të dërguara nga organizata, më të rejat së pari, një faqe keyset. Veprimi listEmailMarketingMessages. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP.
Listat
GET /v1/email-marketing/lists — Listat e postimeve të organizatës me numrin e të regjistruarve / çregjistruarve. Operacioni listEmailMarketingLists. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
POST /v1/email-marketing/lists — Krijoni një listë postimesh (ose ktheni atë me atë emër). Operacioni createEmailMarketingList. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
POST /v1/email-marketing/lists/{list_id}/members — Shtoni kontakte në një listë me anë të adresës së emailit (më së shumti 1.000 për kërkesë). Operacioni addEmailMarketingListMembers. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
Imports
GET /v1/email-marketing/imports — Importimet e mëparshme të kontakteve, më të rejat së pari, nga një faqe keyset për herë. Operacioni listEmailMarketingImports. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
POST /v1/email-marketing/imports — Importoni një bllok kontaktesh me vërtetimin e pëlqimit të tij. Operacioni createEmailMarketingImport. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
Sign-up forms
GET /v1/email-marketing/forms — Formularët e regjistrimit (opt-in i dyfishtë), më të rinjtë të parët, një faqe keyset. Operacioni listEmailMarketingForms. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
POST /v1/email-marketing/forms — Krijoni një formular regjistrimi që shton personat e konfirmuar në një listë. Operacioni createEmailMarketingForm. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
DELETE /v1/email-marketing/forms/{form_id} — Fshini një formular regjistrimi (personat e konfirmuar tashmë mbeten në listë). Operacioni deleteEmailMarketingForm. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
PATCH /v1/email-marketing/forms/{form_id} — Ndryshoni një formular regjistrimi (tekstin, listën, ridrejtimin, aktivizimin ose çaktivizimin). Operacioni updateEmailMarketingForm. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
Lidhjet e dërgimit
GET /v1/email-marketing/senders — Lidhjet e dërgimit të organizatës. Operacioni listEmailMarketingSenders. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
POST /v1/email-marketing/senders — Lidhni një dërgues fushate (dërgim me Zinn®, ose serverin SMTP personal të klientit). Operacioni createEmailMarketingSender. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: vetëm nga API dhe paneli: mban një sekret që nuk duhet të arrijë kurrë te një model AI (trupi i kërkesës është fjalëkalimi SMTP).
DELETE /v1/email-marketing/senders/{sender_id} — Hiqni një lidhje dërgimi dhe fjalëkalimin e saj të ruajtur. Operacioni deleteEmailMarketingSender. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
POST /v1/email-marketing/senders/{sender_id}/verify — Vërtetoni funksionimin e një lidhjeje dërgimi, pa dërguar asgjë. Operacioni verifyEmailMarketingSender. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
PUT /v1/email-marketing/senders/{sender_id}/webhook — Ruani sekretin e nënshkrimit të webhook-ut të ofruesit tuaj të postës elektronike për këtë lidhje. Operacioni setEmailMarketingSenderWebhook. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: thirret nga një sistem tjetër (një ofrues ose një vizitor), jo nga ju (ruan një sekret webhook-u të ofruesit).
SMS dhe WhatsApp
GET /v1/email-marketing/sms — Çfarë i nevojitet ekranit të SMS — e hapur?, e pezulluar?, gjendja e kredive dhe çmimet. Veprimi getEmailMarketingSms. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
GET /v1/email-marketing/sms/campaigns — Fushata masive me SMS, fillimisht më të rejat, një faqe keyset. Veprimi listSmsMarketingCampaigns. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
POST /v1/email-marketing/sms/campaigns — Krijoni një draft SMS për një listë. Veprimi createSmsMarketingCampaign. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
GET /v1/email-marketing/sms/campaigns/{campaign_id} — Një fushatë masive me SMS. Veprimi getSmsMarketingCampaign. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — Redaktoni një draft (ose një fushatë të refuzuar, e cila kthehet në draft). Veprimi updateSmsMarketingCampaign. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — Shifrat e një fushate masive me SMS. Veprimi getSmsMarketingCampaignReport. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — Nisni dërgimin e një SMS-i për të gjithë në listën e tij që kanë pranuar SMS — ose rinisni një fushatë të pezulluar për mungesë krediti. Veprimi sendSmsMarketingCampaign. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: vetëm API dhe paneli i kontrollit: shpenzon para ose kuotë, prandaj duhet të shtypet nga një person (dërgon mesazhe me pagesë SMS/WhatsApp).
GET /v1/email-marketing/sms/registrations/us — Regjistrimi US 10DLC i kësaj organizate dhe kostoja e tij. Veprimi getEmailMarketingUsRegistration. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP.
POST /v1/email-marketing/sms/registrations/us — Dërgoni markën dhe fushatën e kësaj organizate për US 10DLC (tarifimi kryhet gjatë dërgimit). Veprimi submitEmailMarketingUsRegistration. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: vetëm API dhe paneli i kontrollit: shpenzon para ose kuotë, prandaj duhet të shtypet nga një person (regjistrimi US 10DLC përmban tarifa operatori).
Fushata përmes shërbimit tuaj të postës elektronike (shabllone, segmente, ndalime)
GET /v1/campaigns — Fushatat e organizatës. Veprimi listCampaigns. Nga një asistent AI: po, përmes MCP.
POST /v1/campaigns — Krijoni një fushatë nga një shabllon dhe një audiencë. Veprimi createCampaign. Nga një asistent AI: po, përmes MCP.
DELETE /v1/campaigns/esp — Shkëputni llogarinë e ofruesit dhe hiqni çelësin e saj të ruajtur. Veprimi disconnectEsp. Nga një asistent AI: vetëm API dhe paneli: mban një sekret që nuk duhet të arrijë kurrë te një model AI (shkatërron çelësin e ruajtur të ESP).
GET /v1/campaigns/esp — Vetë llogaria e ofruesit të postës elektronike të organizatës. Veprimi getEspConnection. Nga një asistent AI: po, përmes MCP.
POST /v1/campaigns/esp — Lidhni një llogari ofruesi të postës elektronike. Veprimi connectEsp. Nga një asistent AI: vetëm API dhe paneli: mban një sekret që nuk duhet të arrijë kurrë te një model AI (trupi është çelësi API i ESP).
POST /v1/campaigns/esp/verify — Vërtetoni që llogaria e ofruesit funksionon dhe lexoni domenet e saj të verifikuara. Veprimi verifyEspConnection. Nga një asistent AI: vetëm API dhe paneli: mban një sekret që nuk duhet të arrijë kurrë te një model AI (ri-verifikon një çelës të ruajtur të ESP).
POST /v1/campaigns/preview — Bëni Render një shablloni me vlera shembull. Veprimi previewCampaignTemplate. Nga një asistent AI: po, përmes MCP.
GET /v1/campaigns/segments — Segmentet tuaja të ruajtura të audiencës. Veprimi listCampaignSegments. Lejet e kontrolluara: campaigns.view. Nga një asistent AI: po, përmes MCP.
POST /v1/campaigns/segments — Ruani një segment të ri audience. Veprimi createCampaignSegment. Lejet e kontrolluara: campaigns.manage. Nga një asistent AI: po, përmes MCP.
GET /v1/campaigns/segments/fields — Fjalori i filtrave, listat e vlerave të tij dhe etiketat magjike. Veprimi getCampaignSegmentFields. Lejet e kontrolluara: campaigns.view. Nga një asistent AI: po, përmes MCP-së.
POST /v1/campaigns/segments/preview — Sa persona arrin kjo, cilët janë ata dhe kë lë jashtë. Veprimi previewCampaignSegment. Lejet e kontrolluara: campaigns.view. Nga një asistent AI: po, përmes MCP-së.
DELETE /v1/campaigns/segments/{segmentId} — Arkivoni një segment. Veprimi archiveCampaignSegment. Lejet e kontrolluara: campaigns.manage. Nga një asistent AI: po, përmes MCP-së.
GET /v1/campaigns/segments/{segmentId} — Një segment i ruajtur. Veprimi getCampaignSegment. Lejet e kontrolluara: campaigns.view. Nga një asistent AI: po, përmes MCP-së.
PATCH /v1/campaigns/segments/{segmentId} — Riemërtoni një segment ose ndryshoni filtrat e tij. Veprimi updateCampaignSegment. Lejet e kontrolluara: campaigns.manage. Nga një asistent AI: po, përmes MCP-së.
GET /v1/campaigns/suppressions — Adresat që nuk duhet të marrin materiale marketingu. Veprimi listCampaignSuppressions. Lejet e kontrolluara: campaigns.view. Nga një asistent AI: po, përmes MCP-së.
POST /v1/campaigns/suppressions — Shtoni një adresë në listën e ndalimit. Veprimi createCampaignSuppression. Lejet e kontrolluara: campaigns.manage. Nga një asistent AI: po, përmes MCP-së.
GET /v1/campaigns/tags — Paleta e etiketave magjike që ofron një hartues fushatash. Veprimi listCampaignTags. Nga një asistent AI: po, përmes MCP.
GET /v1/campaigns/templates — Shabllonet e fushatës së organizatës. Veprimi listCampaignTemplates. Nga një asistent AI: po, përmes MCP.
POST /v1/campaigns/templates — Krijoni një shabllon fushate. Veprimi createCampaignTemplate. Nga një asistent AI: po, përmes MCP.
DELETE /v1/campaigns/templates/{templateId} — Arkivoni një shabllon dhe nxirrni nga përdorimi burimet e përkthimit të tij. Veprimi archiveCampaignTemplate. Nga një asistent AI: po, përmes MCP.
GET /v1/campaigns/templates/{templateId} — Një shabllon fushate. Veprimi getCampaignTemplate. Nga një asistent AI: po, përmes MCP.
PUT /v1/campaigns/templates/{templateId} — Modifikoni një shabllon fushate. Veprimi updateCampaignTemplate. Nga një asistent AI: po, përmes MCP.
POST /v1/campaigns/unsubscribe — Dilni nga një listë marketingu. Nuk nevojitet llogari. Veprimi unsubscribeFromCampaigns. Nga një asistent AI: vetëm API dhe paneli i kontrollit: mbart një sekret që nuk duhet të mbërrijë kurrë te një model AI (merr token-in e nënshkruar të çregjistrimit të marrësit).
DELETE /v1/campaigns/{campaignId} — Fshini një fushatë dhe nxirrni nga përdorimi rreshtat e dorëzimit të saj. Veprimi deleteCampaign. Nga një asistent AI: vetëm API dhe paneli i kontrollit: kërkon një leje që nuk u ofrohet lidhjeve AI (fshirja e një fushate ESP kërkon campaigns.send).
GET /v1/campaigns/{campaignId} — Një fushatë dhe raporti i dërgimit të saj. Veprimi getCampaign. Nga një asistent AI: po, përmes MCP.
POST /v1/campaigns/{campaignId}/control — Pezulloni, rifilloni ose anuloni një dërgim në proces. Veprimi controlCampaign. Nga një asistent AI: vetëm nëpërmjet API dhe panelit të kontrollit: kjo shpenzon para ose kuotë, prandaj shtypet nga një person (pezullon/rifillon një dërgim të drejtpërdrejtë).
POST /v1/campaigns/{campaignId}/send — Nisni dërgimin e qëndrueshëm. Veprimi sendCampaign. Nga një asistent AI: vetëm nëpërmjet API dhe panelit të kontrollit: kjo shpenzon para ose kuotë, prandaj shtypet nga një person (dërgon një fushatë ESP te marrës realë).
POST /v1/campaigns/{campaignId}/test — Dërgoni një mesazh real në kanalin që fushata do të përdorë realisht. Veprimi testSendCampaign. Nga një asistent AI: vetëm nëpërmjet API dhe panelit të kontrollit: kërkon një leje që nuk u ofrohet lidhjeve AI (një dërgim prove ESP kërkon campaigns.send).
Faqet publike dhe njoftimet hyrëse webhook
GET /v1/public/email-marketing/c/{token} — Numëruesi i klikimeve. Regjistron një klikim për çdo marrës dhe ridrejton te lidhja origjinale. Veprimi emailMarketingClick. Nga një asistent AI: një faqe që marrësit tuaj hapin nga një email (ridrejtimi i gjurmimit të klikimeve).
GET /v1/public/email-marketing/f/{public_id} — Faqja e hostuar e një formulari regjistrimi (pa hyrje në llogari). Veprimi emailMarketingFormPage. Nga një asistent AI: një faqe që marrësit tuaj hapin nga një email (faqja publike e formularit të regjistrimit).
POST /v1/public/email-marketing/f/{public_id} — Dërgoni një formular regjistrimi (faqe e moduruar, e integruar ose JSON). Operacioni emailMarketingFormSubmit. Nga një asistent AI: thirret nga një sistem tjetër (një ofrues ose një vizitor), jo nga ju (një vizitor dërgon një formular regjistrimi).
GET /v1/public/email-marketing/fc — Faqja e konfirmimit me pëlqim të dyfishtë (pa hyrje në llogari). Operacioni emailMarketingFormConfirmPage. Nga një asistent AI: një faqe që marrësit tuaj e hapin nga një email (faqja e konfirmimit me pëlqim të dyfishtë).
POST /v1/public/email-marketing/fc — Konfirmoni një regjistrim (shton personin në listë me një regjistrim pëlqimi). Operacioni emailMarketingFormConfirm. Nga një asistent AI: thirret nga një sistem tjetër (një ofrues ose një vizitor), jo nga ju (një vizitor konfirmon një pëlqim të dyfishtë).
GET /v1/public/email-marketing/o/{token} — Imazhi i gjurmimit të hapjes (një GIF 1x1). Numëron një hapje për marrës. Operacioni emailMarketingOpenPixel. Nga një asistent AI: një faqe që marrësit tuaj e hapin nga një email (pikseli i gjurmimit të hapjes).
GET /v1/public/email-marketing/u/{token} — Lidhja e çregjistrimit në fund të faqes (pa hyrje në llogari). Operacioni emailMarketingUnsubscribePage. Nga një asistent AI: një faqe që marrësit tuaj e hapin nga një email (faqja e çregjistrimit).
POST /v1/public/email-marketing/u/{token} — Çregjistrim me një klikim sipas RFC 8058 (dhe butoni "ndalo gjithçka" i faqes). Veprimi emailMarketingUnsubscribeOneClick. Nga një asistent AI: thirret nga një sistem tjetër (një ofrues ose një vizitor), jo nga ju (çregjistrim me një klikim sipas RFC 8058).
GET /v1/public/email-marketing/warmup-u/{token} — Linku i çregjistrimit të email-it të ngrohjes së grupit të marketingut (pa hyrje në llogari). Veprimi emailMarketingWarmupUnsubscribePage. Nga një asistent AI: një faqe që marrësit tuaj e hapin nga një email (faqja e çregjistrimit të ngrohjes).
POST /v1/public/email-marketing/warmup-u/{token} — Çregjistrim me një klikim sipas RFC 8058 nga email-i i ngrohjes. Veprimi emailMarketingWarmupUnsubscribeOneClick. Nga një asistent AI: thirret nga një sistem tjetër (një ofrues ose një vizitor), jo nga ju (çregjistrim me një klikim nga ngrohja).
POST /v1/webhooks/campaign-events — Prano një ngjarje të nënshkruar dërgimi nga ofruesi i email-it. Veprimi receiveCampaignDeliveryWebhook. Nga një asistent AI: thirret nga një sistem tjetër (një ofrues ose një vizitor), jo nga ju (webhook i nënshkruar i dërgimit nga ESP).
POST /v1/webhooks/campaigns/telnyx — Përgjigje hyrëse SMS (STOP / START) nga shitësi ynë i SMS-ve. Veprimi receiveCampaignsTelnyxInbound. Nga një asistent AI: thirret nga një sistem tjetër (një ofrues ose një vizitor), jo nga ju (webhook hyrës i nënshkruar nga Telnyx).
POST /v1/webhooks/email-marketing/{connection_id} — Ngjarjet e dorëzimit nga ofruesi i vetë email-it të klientit për një lidhje dërgimi. Veprimi receiveEmailMarketingProviderWebhook. Nga një asistent AI: thirret nga një sistem tjetër (një ofrues ose një vizitor), jo nga ju (webhook i nënshkruar dërgues-ofrues).
Rrjedhat
GET /v1/email-marketing/flows — Rrjedhat e email-it (mirëseardhje, me pika, një datë vjetore), një faqe keyset. Veprimi listEmailMarketingFlows. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
POST /v1/email-marketing/flows — Krijoni një rrjedhë (fillon si skicë). Veprimi createEmailMarketingFlow. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
DELETE /v1/email-marketing/flows/{flow_id} — Fshini një rrjedhë dhe regjistrimet e saj (ekzekutimet e dërguara mbeten, si fushata). Veprimi deleteEmailMarketingFlow. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
GET /v1/email-marketing/flows/{flow_id} — Një rrjedhë me hapat e saj dhe raportin e saj (të regjistruar, në proces, ekzekutimet dhe marrësit për hap). Veprimi getEmailMarketingFlow. Lejet e kontrolluara: email_marketing.view. Nga një asistent AI: po, përmes MCP-së.
PATCH /v1/email-marketing/flows/{flow_id} — Ndryshoni një rrjedhë; steps, kur jepet, zëvendëson të gjithë sekuencën. Veprimi updateEmailMarketingFlow. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP.
POST /v1/email-marketing/flows/{flow_id}/activate — Aktivizoni një rrjedhë; regjistrohen vetëm personat që i bashkohen listës që tani e tutje. Veprimi activateEmailMarketingFlow. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP.
POST /v1/email-marketing/flows/{flow_id}/pause — Vendosni në pauzë një rrjedhë; hapat e radhës presin dhe askujt të ri nuk i dërgohet email derisa të riaktivizohet. Veprimi pauseEmailMarketingFlow. Lejet e kontrolluara: email_marketing.manage, email_marketing.view. Nga një asistent AI: po, përmes MCP.