Zinn® Campaigns API və MCP: tərtibatçı təlimatı

İdarəetmə panelində Zinn® Campaigns daxilində edə biləcəyiniz hər şeyi API vasitəsilə də edə bilərsiniz və bunların əksəriyyətini MCP vasitəsilə hesabınıza qoşulmuş bir süni intellekt köməkçisindən həyata keçirə bilərsiniz. Bu bələdçi daxil olmağı, icazələri, hər iki üsul üzrə işlənmiş nümunəni, məhdudiyyətləri, xətaları və 89 Campaigns əməliyyatının hər birini əhatə edir. Aşağıdakı əməliyyat siyahısı bizim API spesifikasiyamızdan tərtib olunmuşdur, buna görə də həmişə API-nin etdikləri ilə tam uyğun gəlir. Hər bir əməliyyatın hər bir sahəsi zinndigital.com/developers/api/zinn-campaigns ünvanındakı API soraqçasında yerləşir.

Daxil olma

• API açarları. İdarəetmə panelində Tənzimləmələr → API açarları bölməsində açar yaradın və onu Authorization: Bearer zdk_live_… kimi göndərin (zdk_test_… açarı sandbox rejimində işləyir). Açara yalnız ehtiyacı olan Campaigns icazələrini verin və artıq heç nə əlavə etməyin.
• Süni intellekt köməkçiləri (MCP). Tətbiqdən daxil olmaqla və ya bağlantı tokeni (zmcp_live_…) vasitəsilə Claude, ChatGPT, Cursor və ya hər hansı bir MCP müştərisini https://api.zinndigital.com/v1/mcp ünvanına qoşun. Claude, Cursor və ya ChatGPT-nin hesabınıza qoşulması bölməsinə baxın. Razılıq ekranında Zinn® Campaigns icazələrini işarələyin.
• İcazələr. email_marketing.view kampaniyaları, siyahıları, kontaktları, formaları, göndərənləri, SMS tənzimləmələrini və hesabatları oxuyur; email_marketing.manage isə onları yaradır və dəyişir. Öz e-poçt xidmətiniz vasitəsilə göndərdiyiniz kampaniyalar campaigns.view və campaigns.manage icazələrindən istifadə edir.
• Təkrar satıcılar. Müştəri təşkilatlarınızdan birində əməliyyat aparmaq üçün org_id ötürün. Açarınız və ya bağlantınız tam olaraq bir təşkilatı əhatə etdikdə onu ötürməyin.

Nümunə: API ilə qaralama kampaniyanın yaradılması

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"
}'

Cavab qaralama ilə birlikdə 201-dir. Onu POST /v1/email-marketing/campaigns/{campaign_id}/test ilə sınaqdan keçirin, onu GET /v1/email-marketing/campaigns/{campaign_id}/lint ilə yoxlayın və POST /v1/email-marketing/campaigns/{campaign_id}/send ilə göndərin.

Nümunə: süni intellekt köməkçisindən eyni qaralama

Köməkçinizdən sadə sözlərlə xahiş edin, məsələn, "Mövzusu 'Bahar endirimiz bu gün başlayır' olan Yaz endirimi adlı Zinn® Campaigns e-poçtu qaralayın". Pərdəarxasında o, əməliyyatı api_operations_search ilə tapır, parametrlərini api_operation_get ilə oxuyur və onu api_operation_call ilə icra edir:

{
  "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"
      }
    }
  }
}

Köməkçinin etməyəcəyi işlər. Alıcılarınıza göndəriş edən və ya pul və ya limit sərf edən hər hansı bir əməliyyat — kampaniya göndərmək, SMS və ya WhatsApp mesajları göndərmək, AI kreditləri ilə yazmaq, US mesajlaşması üçün qeydiyyatdan keçmək — köməkçiyə qadağandır, beləliklə, səhv başa düşülmüş bir təlimat heç vaxt müştərilərinizə çatmaz. Köməkçi qaralamanı hazırlayır; siz idarəetmə panelində Göndər düyməsini sıxırsınız və ya API-ni özünüz çağırırsınız. SMTP şifrəsi kimi məxfi məlumatlar da heç vaxt köməkçi vasitəsilə ötürülmür: onları idarəetmə panelinə daxil edin.

Limitlər

• Hər bir şəxs və ya API açarı üçün dəqiqədə 1200 sorğu, və hər təşkilat üçün dəqiqədə 6000 sorğu. İkisindən daha sərt olanı tətbiq edilir.
• Hər bir MCP bağlantısı üçün dəqiqədə 600 sorğu.
• Limit aşılarsa, cavab Retry-After başlığı ilə birlikdə 429 olur: həmin sayda saniyə gözləyin.
• Siyahı üzvlərinin əlavə edilməsi hər sorğu üçün ən çox 1000 ünvan qəbul edir; tarif planınızın əlaqə və e-poçt limitləri API vasitəsilə etdiyiniz hər şeyə tətbiq olunur.

Xətalar

Hər bir xəta eyni formata malikdir:

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

code eyni problem üçün heç vaxt dəyişmir, ona görə də message əvəzinə onu yoxlayın. Dəstək xidməti ilə əlaqə saxlayarkən request_id qeyd edin. Qarşılaşacağınız cavablar: 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 CONFLICT, 422 UNPROCESSABLE_ENTITY, 429 TOO_MANY_REQUESTS. 403 açarın və ya bağlantının aşağıdakı siyahıda göstərilən icazəyə malik olmadığını bildirir; 404 həmçinin təşkilatda görə bilmədiyiniz bir şeyi əhatə edir; 422 details bölməsində hər bir səhv sahəni sadalayır; 429 xətasından sonra, Retry-After başlığındakı saniyə sayı qədər gözləyin.

Vebhuklar (Webhooks)

Çatdırılma nəticələri e-poçtunuzu göndərən provayderdən Zinn® Campaigns sisteminə daxil olur:

• Öz provayderinizlə (məsələn, Resend), idarəetmə panelindəki göndərmə bağlantısında onun vebhuk imza məxfiliyini saxlayın (Campaigns → Sending). Siz webhook_url əldə edirsiniz; provayderin çatdırıldı, geri qayıtdı və şikayət edildi hadisələrini ona yönləndirin. Qayıtma və ya spam şikayəti ünvanı dərhal gələcək göndərişlərdən silir.
• Zinn® göndərişi ilə quraşdırılacaq heç nə yoxdur.

Nəticələri hesabat əməliyyatları ilə oxuyun (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).

Hər bir Campaigns əməliyyatı

Ümumi baxış

• GET /v1/email-marketing — Bir təşkilat üçün Zinn® Campaigns ümumi baxışı. getEmailMarketingOverview əməliyyatı. Yoxlanılan icazələr: email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.

E-poçt kampaniyaları

• GET /v1/email-marketing/campaigns — E-poçt kampaniyaları, ən yenilər əvvəlcə, bir açar dəsti səhifəsi. Əməliyyat listEmailMarketingCampaigns. Yoxlanılan icazələr: email_marketing.view. AI köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/email-marketing/campaigns — Qaralama e-poçt kampaniyası yaradın. Əməliyyat createEmailMarketingCampaign. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. AI köməkçisindən: bəli, MCP vasitəsilə.
• GET /v1/email-marketing/campaigns/{campaign_id} — Bir e-poçt kampaniyası. Əməliyyat getEmailMarketingCampaign. Yoxlanılan icazələr: email_marketing.view. AI köməkçisindən: bəli, MCP vasitəsilə.
• PATCH /v1/email-marketing/campaigns/{campaign_id} — Qaralamanı redaktə edin (və ya qaralamaya qayıdan rədd edilmiş kampaniyanı). Əməliyyat updateEmailMarketingCampaign. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. AI köməkçisindən: bəli, MCP vasitəsilə.
• GET /v1/email-marketing/campaigns/{campaign_id}/lint — Kampaniya göndərilməzdən əvvəl onun mətnini çatdırılma problemlərinə görə yoxlayın. Əməliyyat lintEmailMarketingCampaign. Yoxlanılan icazələr: email_marketing.view. AI köməkçisindən: bəli, MCP vasitəsilə.
• GET /v1/email-marketing/campaigns/{campaign_id}/report — Kampaniyanın göstəriciləri. Əməliyyat getEmailMarketingCampaignReport. Yoxlanılan icazələr: email_marketing.view. AI köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/email-marketing/campaigns/{campaign_id}/send — Kampaniyanın öz siyahısına göndərilməsinə başlayın. Əməliyyat sendEmailMarketingCampaign. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. AI köməkçisindən: Yalnız API və idarəetmə paneli: vəsait və ya limit xərcləyir, buna görə də düyməni şəxs özü sıxır (real alıcılara göndərir və limiti xərcləyir).
• POST /v1/email-marketing/campaigns/{campaign_id}/test — İndi təşkilatın üzvünə bir sınaq nüsxəsi göndərin. Əməliyyat testEmailMarketingCampaign. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. AI köməkçisindən: Bəli, MCP vasitəsilə.
• POST /v1/email-marketing/campaigns/{campaign_id}/translate — Kampaniyanı çatışmayan və ya köhnəlmiş hər bir əlaqə dilinə tərcümə edin. Əməliyyat translateEmailMarketingCampaign. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. AI köməkçisindən: Bəli, MCP vasitəsilə.
• GET /v1/email-marketing/campaigns/{campaign_id}/translations — Kampaniya siyahısının hər bir əlaqə dili və onun tərcüməsinin cari olub-olmaması. Əməliyyat listEmailMarketingCampaignTranslations. Yoxlanılan icazələr: email_marketing.view. AI köməkçisindən: Bəli, MCP vasitəsilə.

AI ilə yazma

• POST /v1/email-marketing/ai/write — Zinn® AI ilə qısa xülasədən qaralama kampaniya e-poçtu yazın. Əməliyyat writeEmailMarketingCampaignWithAi. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. AI köməkçisindən: yalnız API və idarəetmə paneli: vəsait və ya limit xərcləyir, buna görə də düyməni insan sıxır (AI yazısı AI kreditlərini xərcləyir).

Brend dəsti

• GET /v1/email-marketing/brand-kit — Təşkilatın brend dəsti (ad, loqo, rənglər, şrift, səs tonu). Əməliyyat getEmailMarketingBrandKit. Yoxlanılan icazələr: email_marketing.view. AI köməkçisindən: bəli, MCP vasitəsilə.
• PUT /v1/email-marketing/brand-kit — Brend dəstini redaktə edin. Əməliyyat updateEmailMarketingBrandKit. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. AI köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/email-marketing/brand-kit/read — Brend dəstini təşkilatın veb-saytından oxuyun. Əməliyyat readEmailMarketingBrandKit. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. AI köməkçisindən: bəli, MCP vasitəsilə.

Əlaqələr və birdəfəlik mesajlar

• GET /v1/email-marketing/contacts — Təşkilatın kontaktları, hər dəfə bir keyset səhifəsi. Əməliyyat listEmailMarketingContacts. Yoxlanılan icazələr: email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/email-marketing/contacts/{contact_id}/messages — Zinn® kredit balansından ödənilməklə, bir kontakta bir SMS göndərin. Əməliyyat sendEmailMarketingMessage. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Süni intellekt köməkçisindən: yalnız API və idarə paneli: vəsait və ya limit xərcləyir, buna görə də bir şəxs onu basır (kontakta göndərilən birdəfəlik mesaj limit xərcləyir).
• GET /v1/email-marketing/messages — Təşkilatın göndərdiyi SMS və WhatsApp mesajları, əvvəlcə ən yeniləri, bir keyset səhifəsi. Əməliyyat listEmailMarketingMessages. Yoxlanılan icazələr: email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.

Siyahılar

• GET /v1/email-marketing/lists — Abunə olan / abunəlikdən çıxan sayları ilə təşkilatın poçt siyahıları. Əməliyyat listEmailMarketingLists. Yoxlanılan icazələr: email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/email-marketing/lists — Poçt siyahısı yaradın (və ya həmin adda olanı qaytarın). Əməliyyat createEmailMarketingList. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/email-marketing/lists/{list_id}/members — E-poçt ünvanı ilə siyahıya kontaktlar əlavə edin (hər sorğu üçün ən çox 1000). Əməliyyat addEmailMarketingListMembers. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.

İdxallar

• GET /v1/email-marketing/imports — Keçmiş kontakt idxalları, ən yenilər birinci olmaqla, hər dəfə bir keyset səhifəsi. Əməliyyat listEmailMarketingImports. Yoxlanılan icazələr: email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/email-marketing/imports — Razılıq təsdiqi ilə birlikdə kontaktların bir hissəsini idxal edin. Əməliyyat createEmailMarketingImport. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.

Qeydiyyat formaları

• GET /v1/email-marketing/forms — Qeydiyyat formaları (ikiqat təsdiqləmə), əvvəlcə ən yenilər, bir keyset səhifəsi. Əməliyyat listEmailMarketingForms. Yoxlanılan icazələr: email_marketing.view. AI köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/email-marketing/forms — Təsdiqlənmiş şəxsləri bir siyahıya əlavə edən qeydiyyat forması yaradın. Əməliyyat createEmailMarketingForm. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. AI köməkçisindən: bəli, MCP vasitəsilə.
• DELETE /v1/email-marketing/forms/{form_id} — Qeydiyyat formasını silin (artıq təsdiqlənmiş şəxslər siyahıda qalır). Əməliyyat deleteEmailMarketingForm. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. AI köməkçisindən: bəli, MCP vasitəsilə.
• PATCH /v1/email-marketing/forms/{form_id} — Qeydiyyat formasını dəyişdirin (mətn, siyahı, yönləndirmə, açıq və ya qapalı). Əməliyyat updateEmailMarketingForm. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. AI köməkçisindən: bəli, MCP vasitəsilə.

Göndərmə bağlantıları

• GET /v1/email-marketing/senders — Təşkilatın göndərmə bağlantıları. Əməliyyat listEmailMarketingSenders. Yoxlanılan icazələr: email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/email-marketing/senders — Kampaniya göndərəni qoşun (Zinn® göndərişi və ya müştərinin öz SMTP serveri). Əməliyyat createEmailMarketingSender. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Süni intellekt köməkçisindən: yalnız API və idarəetmə paneli: heç vaxt süni intellekt modelinə çatmamalı olan məxfi məlumatı daşıyır (gövdə SMTP şifrəsidir).
• DELETE /v1/email-marketing/senders/{sender_id} — Göndərmə bağlantısını və onun saxlanılan şifrəsini silin. Əməliyyat deleteEmailMarketingSender. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/email-marketing/senders/{sender_id}/verify — Heç bir şey göndərmədən göndərmə bağlantısının işlədiyini sübut edin. Əməliyyat verifyEmailMarketingSender. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.
• PUT /v1/email-marketing/senders/{sender_id}/webhook — Bu bağlantı üçün e-poçt provayderinizin webhook imzalama məxfi açarını saxlayın. Əməliyyat setEmailMarketingSenderWebhook. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Süni intellekt köməkçisindən: sizin tərəfinizdən deyil, başqa bir sistem (provayder və ya ziyarətçi) tərəfindən çağırılır (provayderin webhook məxfi açarını saxlayır).

SMS və WhatsApp

• GET /v1/email-marketing/sms — SMS ekranının ehtiyac duyduğu məlumatlar — açıqdır?, dayandırılıb?, kredit balansı və qiymətlər. Əməliyyat: getEmailMarketingSms. Yoxlanılan icazələr: email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.
• GET /v1/email-marketing/sms/campaigns — Kütləvi SMS kampaniyaları, əvvəlcə ən yenilər, bir keyset səhifəsi. Əməliyyat: listSmsMarketingCampaigns. Yoxlanılan icazələr: email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/email-marketing/sms/campaigns — Siyahıya göndəriləcək qaralama SMS yaradın. Əməliyyat: createSmsMarketingCampaign. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.
• GET /v1/email-marketing/sms/campaigns/{campaign_id} — Bir kütləvi SMS kampaniyası. Əməliyyat: getSmsMarketingCampaign. Yoxlanılan icazələr: email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.
• PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — Qaralamanı redaktə edin (və ya qaralamaya qayıdan rədd edilmiş kampaniyanı). Əməliyyat: updateSmsMarketingCampaign. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.
• GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — Kütləvi SMS kampaniyasının göstəriciləri. Əməliyyat: getSmsMarketingCampaignReport. Yoxlanılan icazələr: email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — Siyahısında SMS almağa razı olan hər kəsə SMS göndərməyə başlayın — və ya kredit səbəbindən dayandırılmış göndərişi bərpa edin. Əməliyyat: sendSmsMarketingCampaign. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Sİ köməkçisindən: yalnız API və idarəetmə paneli vasitəsilə: vəsait və ya limit xərcləyir, buna görə də düyməni şəxs özü basmalıdır (ödənişli SMS/WhatsApp mesajları göndərir).
• GET /v1/email-marketing/sms/registrations/us — Bu təşkilatın US 10DLC qeydiyyatı və bir qeydiyyatın qiyməti. Əməliyyat: getEmailMarketingUsRegistration. Yoxlanılan icazələr: email_marketing.view. Sİ köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/email-marketing/sms/registrations/us — Bu təşkilatın brendini və kampaniyasını US 10DLC üçün təqdim edin (təqdim edildikdə ödəniş tutulur). Əməliyyat: submitEmailMarketingUsRegistration. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Sİ köməkçisindən: yalnız API və idarəetmə paneli vasitəsilə: vəsait və ya limit xərcləyir, buna görə də düyməni şəxs özü basmalıdır (US 10DLC qeydiyyatı operator rüsumlarına tabedir).

Öz e-poçt xidmətiniz vasitəsilə kampaniyalar (şablonlar, seqmentlər, istisnalar)

• GET /v1/campaigns — Təşkilatın kampaniyaları. Əməliyyat: listCampaigns. Sİ köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/campaigns — Şablon və auditoriya əsasında kampaniya yaradın. Əməliyyat: createCampaign. Sİ köməkçisindən: bəli, MCP vasitəsilə.
• DELETE /v1/campaigns/esp — Təchizatçı hesabının bağlantısını kəsin və saxlanılan açarını silin. Əməliyyat disconnectEsp. Sİ köməkçisindən: Yalnız API və idarəetmə paneli: heç vaxt Sİ modelinə çatmamalı olan məxfi məlumat daşıyır (saxlanılan ESP açarını məhv edir).
• GET /v1/campaigns/esp — Təşkilatın öz e-poçt təchizatçısı hesabı. Əməliyyat getEspConnection. Sİ köməkçisindən: Bəli, MCP vasitəsilə.
• POST /v1/campaigns/esp — E-poçt təchizatçısı hesabını bağlayın. Əməliyyat connectEsp. Sİ köməkçisindən: Yalnız API və idarəetmə paneli: heç vaxt Sİ modelinə çatmamalı olan məxfi məlumat daşıyır (gövdə ESP API açarıdır).
• POST /v1/campaigns/esp/verify — Təchizatçı hesabının işlədiyini sübut edin və onun təsdiqlənmiş domenlərini oxuyun. Əməliyyat verifyEspConnection. Sİ köməkçisindən: Yalnız API və idarəetmə paneli: heç vaxt Sİ modelinə çatmamalı olan məxfi məlumat daşıyır (saxlanılan ESP açarını yenidən yoxlayır).
• POST /v1/campaigns/preview — Nümunə dəyərlərlə şablonu Render edin. Əməliyyat previewCampaignTemplate. Sİ köməkçisindən: Bəli, MCP vasitəsilə.
• GET /v1/campaigns/segments — Saxlanılan auditoriya seqmentləriniz. Əməliyyat listCampaignSegments. Yoxlanılan icazələr: campaigns.view. Sİ köməkçisindən: Bəli, MCP vasitəsilə.
• POST /v1/campaigns/segments — Yeni auditoriya seqmentini yadda saxlayın. Əməliyyat createCampaignSegment. Yoxlanılan icazələr: campaigns.manage. Sİ köməkçisindən: Bəli, MCP vasitəsilə.
• GET /v1/campaigns/segments/fields — Filtr lüğəti, onun dəyər siyahıları və sehrli teqlər. Əməliyyat getCampaignSegmentFields. Yoxlanılan icazələr: campaigns.view. Sİ köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/campaigns/segments/preview — Bunun neçə nəfərə çatdığı, onların kim olduğu və kimlərin kənarda qaldığı. Əməliyyat previewCampaignSegment. Yoxlanılan icazələr: campaigns.view. Sİ köməkçisindən: bəli, MCP vasitəsilə.
• DELETE /v1/campaigns/segments/{segmentId} — Seqmenti arxivləşdirin. Əməliyyat archiveCampaignSegment. Yoxlanılan icazələr: campaigns.manage. Sİ köməkçisindən: bəli, MCP vasitəsilə.
• GET /v1/campaigns/segments/{segmentId} — Bir yadda saxlanılmış seqment. Əməliyyat getCampaignSegment. Yoxlanılan icazələr: campaigns.view. Sİ köməkçisindən: bəli, MCP vasitəsilə.
• PATCH /v1/campaigns/segments/{segmentId} — Seqmentin adını dəyişin və ya onun filtrlərinə düzəliş edin. Əməliyyat updateCampaignSegment. Yoxlanılan icazələr: campaigns.manage. Sİ köməkçisindən: bəli, MCP vasitəsilə.
• GET /v1/campaigns/suppressions — Marketinq almamalı olan ünvanlar. Əməliyyat listCampaignSuppressions. Yoxlanılan icazələr: campaigns.view. Sİ köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/campaigns/suppressions — Ünvanı bloklama siyahısına əlavə edin. Əməliyyat createCampaignSuppression. Yoxlanılan icazələr: campaigns.manage. Sİ köməkçisindən: bəli, MCP vasitəsilə.
• GET /v1/campaigns/tags — Kampaniya tərtibçisinin təklif etdiyi sehrli teq palitrası. Əməliyyat listCampaignTags. AI köməkçisindən: bəli, MCP vasitəsilə.
• GET /v1/campaigns/templates — Təşkilatın kampaniya şablonları. Əməliyyat listCampaignTemplates. AI köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/campaigns/templates — Kampaniya şablonu hazırlayın. Əməliyyat createCampaignTemplate. AI köməkçisindən: bəli, MCP vasitəsilə.
• DELETE /v1/campaigns/templates/{templateId} — Şablonu arxivləşdirin və onun tərcümə mənbələrini istifadədən çıxarın. Əməliyyat archiveCampaignTemplate. AI köməkçisindən: bəli, MCP vasitəsilə.
• GET /v1/campaigns/templates/{templateId} — Bir kampaniya şablonu. Əməliyyat getCampaignTemplate. AI köməkçisindən: bəli, MCP vasitəsilə.
• PUT /v1/campaigns/templates/{templateId} — Kampaniya şablonunu redaktə edin. Əməliyyat updateCampaignTemplate. AI köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/campaigns/unsubscribe — Marketinq siyahısını tərk edin. Hesab tələb olunmur. Əməliyyat unsubscribeFromCampaigns. AI köməkçisindən: Yalnız API və idarə paneli: heç vaxt AI modelinə çatmamalı olan məxfi məlumatı daşıyır (alıcının imzalanmış abunəlikdən çıxma tokenini qəbul edir).
• DELETE /v1/campaigns/{campaignId} — Kampaniyanı silin və onun çatdırılma sətirlərini istifadədən çıxarın. Əməliyyat deleteCampaign. AI köməkçisindən: Yalnız API və idarə paneli: AI bağlantılarına təklif edilməyən icazə tələb edir (ESP kampaniyasını silmək üçün campaigns.send tələb olunur).
• GET /v1/campaigns/{campaignId} — Bir kampaniya və onun çatdırılma hesabatı. Əməliyyat getCampaign. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/campaigns/{campaignId}/control — İcrada olan göndərişi dayandırın, davam etdirin və ya ləğv edin. Əməliyyat controlCampaign. Süni intellekt köməkçisindən: yalnız API və idarə paneli: vəsait və ya limit xərcləyir, buna görə də onu insan basmalıdır (canlı göndərişi dayandırır/davam etdirir).
• POST /v1/campaigns/{campaignId}/send — Davamlı göndərişi başladın. Əməliyyat sendCampaign. Süni intellekt köməkçisindən: yalnız API və idarə paneli: vəsait və ya limit xərcləyir, buna görə də onu insan basmalıdır (ESP kampaniyasını real alıcılara göndərir).
• POST /v1/campaigns/{campaignId}/test — Kampaniyanın faktiki olaraq istifadə edəcəyi kanalda bir real mesaj göndərin. Əməliyyat testSendCampaign. Süni intellekt köməkçisindən: yalnız API və idarə paneli: süni intellekt bağlantılarına təqdim edilməyən icazə tələb edir (ESP test göndərişi üçün campaigns.send tələb olunur).

İctimai səhifələr və daxil olan veb-huklar

• GET /v1/public/email-marketing/c/{token} — Klik sayğacı. Hər alıcı üçün bir klik qeyd edir və orijinal keçidə yönləndirir. Əməliyyat emailMarketingClick. Süni intellekt köməkçisindən: alıcılarınızın e-poçtdan açdığı səhifə (klik izləmə yönləndirməsi).
• GET /v1/public/email-marketing/f/{public_id} — Qeydiyyat formasının host edilmiş səhifəsi (giriş tələb olunmur). Əməliyyat emailMarketingFormPage. Süni intellekt köməkçisindən: alıcılarınızın e-poçtdan açdığı səhifə (ictimai qeydiyyat forması səhifəsi).
• POST /v1/public/email-marketing/f/{public_id} — Qeydiyyat formasını təqdim edin (hostinq edilən səhifə, yerləşdirmə və ya JSON). Əməliyyat emailMarketingFormSubmit. Sİ köməkçisindən: sizin tərəfinizdən deyil, başqa bir sistem (təchizatçı və ya ziyarətçi) tərəfindən çağırılır (ziyarətçi qeydiyyat formasını təqdim edir).
• GET /v1/public/email-marketing/fc — İkiqat təsdiq (double opt-in) səhifəsi (giriş tələb olunmur). Əməliyyat emailMarketingFormConfirmPage. Sİ köməkçisindən: alıcılarınızın e-poçtdan açdığı səhifə (ikiqat təsdiq səhifəsi).
• POST /v1/public/email-marketing/fc — Qeydiyyatı təsdiqləyin (razılıq qeydi ilə şəxsi siyahıya əlavə edir). Əməliyyat emailMarketingFormConfirm. Sİ köməkçisindən: sizin tərəfinizdən deyil, başqa bir sistem (təchizatçı və ya ziyarətçi) tərəfindən çağırılır (ziyarətçi ikiqat təsdiqi təsdiqləyir).
• GET /v1/public/email-marketing/o/{token} — Açılmanı izləmə şəkli (1x1 GIF). Hər alıcı üçün bir açılmanı sayır. Əməliyyat emailMarketingOpenPixel. Sİ köməkçisindən: alıcılarınızın e-poçtdan açdığı səhifə (açılmanı izləmə pikseli).
• GET /v1/public/email-marketing/u/{token} — Altlıqdakı abunəlikdən çıxma keçidi (giriş tələb olunmur). Əməliyyat emailMarketingUnsubscribePage. Sİ köməkçisindən: alıcılarınızın e-poçtdan açdığı səhifə (abunəlikdən çıxma səhifəsi).
• POST /v1/public/email-marketing/u/{token} — RFC 8058 bir kliklə abunəlikdən çıxma (və səhifənin "hər şeyi dayandır" düyməsi). Əməliyyat emailMarketingUnsubscribeOneClick. Sİ köməkçisindən: sizin tərəfinizdən deyil, başqa bir sistem (provayder və ya ziyarətçi) tərəfindən çağırılır (RFC 8058 bir kliklə abunəlikdən çıxma).
• GET /v1/public/email-marketing/warmup-u/{token} — Marketinq hovuzunun qızışdırma məktubunun abunəlikdən çıxma keçidi (giriş tələb olunmur). Əməliyyat emailMarketingWarmupUnsubscribePage. Sİ köməkçisindən: alıcılarınızın e-poçtdan açdığı səhifə (qızışdırmadan abunəlikdən çıxma səhifəsi).
• POST /v1/public/email-marketing/warmup-u/{token} — Qızışdırma məktubundan RFC 8058 bir kliklə abunəlikdən çıxma. Əməliyyat emailMarketingWarmupUnsubscribeOneClick. Sİ köməkçisindən: sizin tərəfinizdən deyil, başqa bir sistem (provayder və ya ziyarətçi) tərəfindən çağırılır (qızışdırmadan bir kliklə abunəlikdən çıxma).
• POST /v1/webhooks/campaign-events — E-poçt provayderindən imzalanmış çatdırılma hadisəsini qəbul edin. Əməliyyat receiveCampaignDeliveryWebhook. Sİ köməkçisindən: sizin tərəfinizdən deyil, başqa bir sistem (provayder və ya ziyarətçi) tərəfindən çağırılır (imzalanmış ESP çatdırılma vebhuku).
• POST /v1/webhooks/campaigns/telnyx — SMS təchizatçımızdan daxil olan SMS cavabları (STOP / START). Əməliyyat receiveCampaignsTelnyxInbound. Sİ köməkçisindən: sizin tərəfinizdən deyil, başqa bir sistem (provayder və ya ziyarətçi) tərəfindən çağırılır (imzalanmış Telnyx daxilolma vebhuku).
• POST /v1/webhooks/email-marketing/{connection_id} — Bir göndərmə bağlantısı üçün müştərinin öz e-poçt təminatçısının çatdırılma hadisələri. Əməliyyat: receiveEmailMarketingProviderWebhook. Sİ köməkçisindən: sizin tərəfinizdən deyil, başqa bir sistem tərəfindən çağırılır (təminatçı və ya ziyarətçi) (imzalanmış göndərən-təminatçı veb-huku).

Flows

• GET /v1/email-marketing/flows — E-poçt axınları (xoş gəlmisiniz, damcı, illik tarix), bir keyset səhifəsi. Əməliyyat: listEmailMarketingFlows. Yoxlanılan icazələr: email_marketing.view. Sİ köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/email-marketing/flows — Axın yaradın (qaralama kimi başlayır). Əməliyyat: createEmailMarketingFlow. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Sİ köməkçisindən: bəli, MCP vasitəsilə.
• DELETE /v1/email-marketing/flows/{flow_id} — Axını və onun qeydiyyatlarını silin (göndərilmiş icralar kampaniya kimi qalır). Əməliyyat: deleteEmailMarketingFlow. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Sİ köməkçisindən: bəli, MCP vasitəsilə.
• GET /v1/email-marketing/flows/{flow_id} — Addımları və hesabatı ilə bir axın (qeydiyyatdan keçmiş, davam edən, hər addım üzrə icralar və alıcılar). Əməliyyat: getEmailMarketingFlow. Yoxlanılan icazələr: email_marketing.view. Sİ köməkçisindən: bəli, MCP vasitəsilə.
• PATCH /v1/email-marketing/flows/{flow_id} — Axını dəyişin; steps təqdim edildikdə, bütün ardıcıllığı əvəz edir. Əməliyyat updateEmailMarketingFlow. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/email-marketing/flows/{flow_id}/activate — Axını aktivləşdirin; yalnız bundan sonra siyahıya qoşulan şəxslər qeydiyyata alınır. Əməliyyat activateEmailMarketingFlow. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.
• POST /v1/email-marketing/flows/{flow_id}/pause — Axını dayandırın; icra olunmalı addımlar gözləyir və o yenidən aktivləşdirilənə qədər heç bir yeni şəxsə e-poçt göndərilmir. Əməliyyat pauseEmailMarketingFlow. Yoxlanılan icazələr: email_marketing.manage, email_marketing.view. Süni intellekt köməkçisindən: bəli, MCP vasitəsilə.