Zinn® Campaigns API ו-MCP: מדריך למפתחים

כל מה שאתם יכולים לעשות ב-Zinn® Campaigns בלוח הבקרה, אתם יכולים לעשות גם באמצעות ה-API, ואת רובו מעוזר AI המחובר לחשבונכם באמצעות MCP. מדריך זה מכסה את ההתחברות, ההרשאות, דוגמה מעשית בשתי הדרכים, המגבלות, השגיאות וכל אחת מ-89 פעולות Campaigns. רשימת הפעולות להלן נוצרת מתוך מפרט ה-API שלנו, כך שהיא תמיד תואמת את מה שה-API עושה. כל שדה של כל פעולה נמצא במפרט ה-API בכתובת zinndigital.com/developers/api/zinn-campaigns.

התחברות

• מפתחות API. צרו מפתח בלוח הבקרה תחת הגדרות ← מפתחות API ושלחו אותו בתור Authorization: Bearer zdk_live_… (מפתח zdk_test_… פועל במצב סביבת בדיקות). העניקו למפתח את הרשאות ה-Campaigns הדרושות לו ותו לא.
• עוזרי בינה מלאכותית (MCP). חברו את Claude, את ChatGPT, את Cursor או כל לקוח MCP לכתובת https://api.zinndigital.com/v1/mcp, באמצעות כניסה מהאפליקציה או באמצעות אסימון חיבור (zmcp_live_…). עיינו במדריך חיבור Claude, Cursor או ChatGPT לחשבונכם. במסך ההסכמה, סמנו את הרשאות Zinn® Campaigns.
• הרשאות. email_marketing.view קורא קמפיינים, רשימות, אנשי קשר, טפסים, שולחים, הגדרות SMS ודוחות; email_marketing.manage יוצר ומשנה אותם. הקמפיינים שאתם שולחים דרך שירות הדוא"ל שלכם משתמשים ב-campaigns.view וב-campaigns.manage.
• משווקים מורשים. העבירו את org_id כדי לפעול באחד מארגוני הלקוחות שלכם. השמיטו אותו כאשר המפתח או החיבור שלכם מגיעים לארגון אחד בדיוק.

דוגמה: יצירת טיוטת קמפיין באמצעות ה-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"
}'

התשובה היא 201 בצירוף הטיוטה. בדקו אותה באמצעות POST /v1/email-marketing/campaigns/{campaign_id}/test, בצעו בדיקת תקינות באמצעות GET /v1/email-marketing/campaigns/{campaign_id}/lint, ושלחו אותה באמצעות POST /v1/email-marketing/campaigns/{campaign_id}/send.

דוגמה: אותה טיוטה מעוזר AI

בקשו מהעוזר שלכם במילים פשוטות, למשל "נסח אימייל של Zinn® Campaigns בשם מכירת aviv עם הנושא 'מכירת האביב שלנו מתחילה היום'". מאחורי הקלעים הוא מוצא את הפעולה באמצעות api_operations_search, קורא את הפרמטרים שלה באמצעות api_operation_get, ומפעיל אותה באמצעות 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"
      }
    }
  }
}

מה שהעוזר לא יעשה. כל פעולה ששולחת לנמענים שלכם או כרוכה בהוצאת כסף או מכסה — שליחת קמפיין, שליחת הודעות SMS או WhatsApp, כתיבה באמצעות נקודות זכות של AI, הרשמה לשליחת הודעות טקסט ב-US — נדחית עבור עוזר, כך שהוראה שלא הובנה כהלכה לעולם לא תוכל להגיע ללקוחות שלכם. העוזר מכין את הטיוטה; אתם לוחצים על שלח בלוח הבקרה או קוראים ל-API בעצמכם. סודות כגון סיסמת SMTP לעולם אינם מועברים דרך עוזר: הזינו אותם בלוח הבקרה.

מגבלות

• 1,200 בקשות לדקה עבור כל אדם או מפתח API, ו-6,000 בקשות לדקה עבור כל ארגון. המחמירה מבין השתיים חלה.
• 600 בקשות לדקה עבור כל חיבור MCP.
• בחריגה ממגבלה, התשובה היא 429 עם כותרת Retry-After: המתינו מספר שניות זה.
• הוספת חברי רשימה נמשכת לכל היותר 1,000 כתובות לבקשה; מכסות אנשי הקשר והדוא"ל של התוכנית שלכם חלות על כל מה שאתם מבצעים דרך ה-API.

שגיאות

לכל שגיאה יש את אותו המבנה:

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

ה-code לעולם אינו משתנה עבור אותה בעיה, לכן בדקו אותו במקום את message. ציינו את request_id בעת פנייה לתמיכה. התשובות שתיתקלו בהן: 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 CONFLICT, 422 UNPROCESSABLE_ENTITY, 429 TOO_MANY_REQUESTS. המשמעות של 403 היא שלמפתח או לחיבור חסרה הרשאה המופיעה ברשימה למטה; 404 מכסה גם פריט בארגון שאינכם יכולים לראות; 422 מפרט כל שדה שגוי ב-details; לאחר 429, המתינו את מספר השניות המצוין בכותרת Retry-After.

Webhooks

תוצאות המסירה מגיעות אל Zinn® Campaigns מספק השירות ששולח את האימייל שלכם:

• כאשר אתם משתמשים בספק משלכם (למשל Resend), שמרו את מפתח החתימה הסודי של ה-webhook שלו בחיבור השליחה בלוח הבקרה (קמפיינים ← שליחה). תקבלו webhook_url; הפנו אליו את אירועי ה-delivered, ה-bounced וה-complained של הספק. החזרה (bounce) או תלונת ספאם מסירות מיד את הכתובת משליחות עתידיות.
• בשליחה דרך Zinn®, אין צורך להגדיר דבר.

קראו את התוצאות באמצעות פעולות הדוחות (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).

כל פעולות קמפיינים

סקירה כללית

• GET /v1/email-marketing — סקירה כללית של Zinn® Campaigns עבור ארגון אחד. פעולה: getEmailMarketingOverview. הרשאות שנבדקות: email_marketing.view. מעוזר AI: כן, באמצעות ה-MCP.

קמפיינים באימייל

• GET /v1/email-marketing/campaigns — קמפיינים בדוא"ל, החדשים ביותר תחילה, עמוד keyset אחד. פעולה listEmailMarketingCampaigns. הרשאות שנבדקו: email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/email-marketing/campaigns — יצירת טיוטת קמפיין בדוא"ל. פעולה createEmailMarketingCampaign. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• GET /v1/email-marketing/campaigns/{campaign_id} — קמפיין בדוא"ל אחד. פעולה getEmailMarketingCampaign. הרשאות שנבדקו: email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• PATCH /v1/email-marketing/campaigns/{campaign_id} — עריכת טיוטה (או קמפיין שנדחה, אשר חוזר לטיוטה). פעולה updateEmailMarketingCampaign. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/lint — בדיקת הטקסט של הקמפיין לאיתור בעיות עבירות לפני שליחתו. פעולה lintEmailMarketingCampaign. הרשאות שנבדקו: email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/report — הנתונים המספריים של קמפיין. פעולה getEmailMarketingCampaignReport. הרשאות שנבדקו: email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/send — התחלת שליחת קמפיין לרשימה שלו. פעולה sendEmailMarketingCampaign. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר בינה מלאכותית: API ולוח בקרה בלבד: פעולה זו כרוכה בעלות כספית או בניצול מכסה, ולכן אדם לוחץ עליה (שולח לנמענים אמיתיים ומנצל מכסה).
• POST /v1/email-marketing/campaigns/{campaign_id}/test — שליחת עותק בדיקה אחד כעת לחבר בארגון. פעולה testEmailMarketingCampaign. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/translate — תרגום קמפיין לכל שפת איש קשר שחסרה או אינה מעודכנת. פעולה translateEmailMarketingCampaign. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/translations — כל שפת איש קשר של רשימת קמפיין והאם התרגום שלה עדכני. פעולה listEmailMarketingCampaignTranslations. הרשאות שנבדקו: email_marketing.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.

כתיבה באמצעות בינה מלאכותית

• POST /v1/email-marketing/ai/write — כתיבת טיוטת אימייל לקמפיין מתדריך קצר באמצעות Zinn® AI. פעולה writeEmailMarketingCampaignWithAi. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: API ולוח בקרה בלבד: פעולה זו כרוכה בעלות כספית או מנצלת הקצאה, ולכן אדם לוחץ עליה (כתיבה באמצעות AI מנצלת נקודות זכות של AI).

ערכת מותג

• GET /v1/email-marketing/brand-kit — ערכת המותג של הארגון (שם, סמליל, צבעים, גופן, טון דיבור). פעולה getEmailMarketingBrandKit. הרשאות שנבדקו: email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• PUT /v1/email-marketing/brand-kit — עריכת ערכת המותג. פעולה updateEmailMarketingBrandKit. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/email-marketing/brand-kit/read — קריאת ערכת המותג מאתר האינטרנט של הארגון. פעולה readEmailMarketingBrandKit. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: כן, דרך ה-MCP.

אנשי קשר והודעות חד-פעמיות

• GET /v1/email-marketing/contacts — אנשי הקשר של הארגון, עמוד keyset אחד בכל פעם. פעולה listEmailMarketingContacts. הרשאות שנבדקו: email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/email-marketing/contacts/{contact_id}/messages — שליחת הודעת SMS אחת לאיש קשר אחד, בתשלום מיתרת האשראי של Zinn®. פעולה sendEmailMarketingMessage. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: ב-API ובלוח הבקרה בלבד: הדבר כרוך בעלות כספית או בניצול מכסה, ולכן אדם לוחץ עליו (הודעה חד-פעמית לאיש קשר מנצלת מכסה).
• GET /v1/email-marketing/messages — הודעות SMS ו-WhatsApp שהארגון שלח, החדשות ביותר תחילה, עמוד keyset אחד. פעולה listEmailMarketingMessages. הרשאות שנבדקו: email_marketing.view. מעוזר AI: כן, דרך ה-MCP.

רשימות

• GET /v1/email-marketing/lists — רשימות התפוצה של הארגון עם מספרי רשומים / מבוטלי רישום. פעולה listEmailMarketingLists. הרשאות שנבדקו: email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/email-marketing/lists — יצירת רשימת תפוצה (או החזרת הרשימה בעלת שם זה). פעולה createEmailMarketingList. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/email-marketing/lists/{list_id}/members — הוספת אנשי קשר לרשימה לפי כתובת דוא"ל (לכל היותר 1,000 לבקשה). פעולה addEmailMarketingListMembers. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: כן, דרך ה-MCP.

ייבואים

• GET /v1/email-marketing/imports — ייבויי אנשי קשר קודמים, החדשים ביותר תחילה, דף keyset אחד בכל פעם. פעולה listEmailMarketingImports. הרשאות שנבדקו: email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/email-marketing/imports — ייבוא מקבץ אחד של אנשי קשר עם אישור ההסכמה שלו. פעולה createEmailMarketingImport. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: כן, דרך ה-MCP.

טופסי הרשמה

• GET /v1/email-marketing/forms — טופסי הרשמה (double opt-in), החדשים ביותר תחילה, עמוד keyset אחד. פעולה listEmailMarketingForms. הרשאות שנבדקו: email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/email-marketing/forms — יצירת טופס הרשמה שמוסיף אנשים שאושרו לרשימה אחת. פעולה createEmailMarketingForm. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• DELETE /v1/email-marketing/forms/{form_id} — מחיקת טופס הרשמה (אנשים שכבר אושרו נשארים ברשימה). פעולה deleteEmailMarketingForm. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• PATCH /v1/email-marketing/forms/{form_id} — שינוי טופס הרשמה (ניסוח, רשימה, הפניה מחדש, פעיל או כבוי). פעולה updateEmailMarketingForm. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: כן, דרך ה-MCP.

חיבורי שליחה

• GET /v1/email-marketing/senders — חיבורי השליחה של הארגון. פעולה listEmailMarketingSenders. הרשאות שנבדקו: email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/email-marketing/senders — חיבור שולח קמפיין (שליחת Zinn®, או שרת ה-SMTP של הלקוח עצמו). פעולה createEmailMarketingSender. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: API ולוח בקרה בלבד: הפעולה כוללת סוד שאסור שיגיע למודל AI לעולם (גוף הבקשה הוא סיסמת ה-SMTP).
• DELETE /v1/email-marketing/senders/{sender_id} — הסרת חיבור שליחה והסיסמה השמורה שלו. פעולה deleteEmailMarketingSender. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/email-marketing/senders/{sender_id}/verify — אימות שחיבור שליחה פועל, מבלי לשלוח דבר. פעולה verifyEmailMarketingSender. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• PUT /v1/email-marketing/senders/{sender_id}/webhook — שמירת סוד החתימה של ה-webhook מאת ספק הדוא"ל שלכם עבור חיבור זה. פעולה setEmailMarketingSenderWebhook. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: מופעל על ידי מערכת אחרת (ספק או מבקר), לא על ידיכם (שומר את סוד ה-webhook של ספק).

SMS ו-WhatsApp

• GET /v1/email-marketing/sms — מה שמסך ה-SMS צריך — פתוח?, מושהה?, יתרת נקודות זכות ומחירים. פעולה getEmailMarketingSms. הרשאות שנבדקו: email_marketing.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• GET /v1/email-marketing/sms/campaigns — קמפיינים של הודעות SMS בתפוצה רחבה, החדשים ביותר תחילה, עמוד keyset אחד. פעולה listSmsMarketingCampaigns. הרשאות שנבדקו: email_marketing.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• POST /v1/email-marketing/sms/campaigns — יצירת טיוטת SMS לרשימה. פעולה createSmsMarketingCampaign. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id} — קמפיין אחד של הודעות SMS בתפוצה רחבה. פעולה getSmsMarketingCampaign. הרשאות שנבדקו: email_marketing.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — עריכת טיוטה (או קמפיין שנדחה, החוזר לסטטוס טיוטה). פעולה updateSmsMarketingCampaign. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — הנתונים המספריים של קמפיין הודעות SMS בתפוצה רחבה. פעולה getSmsMarketingCampaignReport. הרשאות שנבדקו: email_marketing.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — התחלת שליחת SMS לכל מי שברשימה שלו שהסכים לקבל SMS — או חידוש שליחה שהושהתה עקב יתרת זכות. פעולה sendSmsMarketingCampaign. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: API ולוח בקרה בלבד: הפעולה כרוכה בעלות כספית או מנצלת מכסה, ולכן אדם לוחץ עליה (שולחת הודעות SMS/WhatsApp בתשלום).
• GET /v1/email-marketing/sms/registrations/us — רישום ה-US 10DLC של ארגון זה, ועלותו. פעולה getEmailMarketingUsRegistration. הרשאות שנבדקו: email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/email-marketing/sms/registrations/us — שליחת המותג ומסע הפרסום של ארגון זה עבור US 10DLC (החיוב מתבצע בעת השליחה). פעולה submitEmailMarketingUsRegistration. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: API ולוח בקרה בלבד: הפעולה כרוכה בעלות כספית או מנצלת מכסה, ולכן אדם לוחץ עליה (רישום US 10DLC כרוך בעמלות ספק תקשורת).

מסעות פרסום דרך שירות הדוא"ל שלכם (תבניות, פלחים, השתקות)

• GET /v1/campaigns — מסעות הפרסום של הארגון. פעולה listCampaigns. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/campaigns — יצירת מסע פרסום מתבנית ומקהל יעד. פעולה createCampaign. מעוזר AI: כן, דרך ה-MCP.
• DELETE /v1/campaigns/esp — נתק את חשבון הספק והסר את המפתח השמור שלו. פעולה disconnectEsp. מעוזר AI: API ולוח בקרה בלבד: הוא נושא סוד שלעולם אסור שיגיע למודל AI (משמיד את מפתח ה-ESP השמור).
• GET /v1/campaigns/esp — חשבון ספק הדוא"ל של הארגון עצמו. פעולה getEspConnection. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/campaigns/esp — חבר חשבון ספק דוא"ל. פעולה connectEsp. מעוזר AI: API ולוח בקרה בלבד: הוא נושא סוד שלעולם אסור שיגיע למודל AI (גוף הבקשה הוא מפתח ה-API של ה-ESP).
• POST /v1/campaigns/esp/verify — ודא שחשבון הספק פועל וקרא את הדומיינים המאומתים שלו. פעולה verifyEspConnection. מעוזר AI: API ולוח בקרה בלבד: הוא נושא סוד שלעולם אסור שיגיע למודל AI (בודק מחדש מפתח ESP שמור).
• POST /v1/campaigns/preview — בצע Render לתבנית עם ערכים לדוגמה. פעולה previewCampaignTemplate. מעוזר AI: כן, דרך ה-MCP.
• GET /v1/campaigns/segments — מקטעי הקהל השמורים שלך. פעולה listCampaignSegments. הרשאות שנבדקו: campaigns.view. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/campaigns/segments — שמור מקטע קהל חדש. פעולה createCampaignSegment. הרשאות שנבדקו: campaigns.manage. מעוזר AI: כן, דרך ה-MCP.
• GET /v1/campaigns/segments/fields — אוצר המילים של הסינון, רשימות הערכים שלו ותגי הקסם. פעולה getCampaignSegmentFields. הרשאות שנבדקו: campaigns.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• POST /v1/campaigns/segments/preview — לכמה אנשים זה מגיע, מי הם ומי נשאר בחוץ. פעולה previewCampaignSegment. הרשאות שנבדקו: campaigns.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• DELETE /v1/campaigns/segments/{segmentId} — העברה של פלח לארכיון. פעולה archiveCampaignSegment. הרשאות שנבדקו: campaigns.manage. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• GET /v1/campaigns/segments/{segmentId} — פלח שמור אחד. פעולה getCampaignSegment. הרשאות שנבדקו: campaigns.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• PATCH /v1/campaigns/segments/{segmentId} — שינוי שם של פלח או שינוי המסננים שלו. פעולה updateCampaignSegment. הרשאות שנבדקו: campaigns.manage. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• GET /v1/campaigns/suppressions — כתובות שאסור להן לקבל תוכן שיווקי. פעולה listCampaignSuppressions. הרשאות שנבדקו: campaigns.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• POST /v1/campaigns/suppressions — הוספת כתובת לרשימת המניעה. פעולה createCampaignSuppression. הרשאות שנבדקו: campaigns.manage. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• GET /v1/campaigns/tags — לוח תגיות הקסם (magic-tag) שיוצר הקמפיינים מציע. פעולה listCampaignTags. מעוזר AI: כן, דרך ה-MCP.
• GET /v1/campaigns/templates — תבניות הקמפיין של הארגון. פעולה listCampaignTemplates. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/campaigns/templates — יצירת תבנית קמפיין. פעולה createCampaignTemplate. מעוזר AI: כן, דרך ה-MCP.
• DELETE /v1/campaigns/templates/{templateId} — העברת תבנית לארכיון והוצאת מקורות התרגום שלה משימוש. פעולה archiveCampaignTemplate. מעוזר AI: כן, דרך ה-MCP.
• GET /v1/campaigns/templates/{templateId} — תבנית קמפיין אחת. פעולה getCampaignTemplate. מעוזר AI: כן, דרך ה-MCP.
• PUT /v1/campaigns/templates/{templateId} — עריכת תבנית קמפיין. פעולה updateCampaignTemplate. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/campaigns/unsubscribe — יציאה מרשימת תפוצה שיווקית. אין צורך בחשבון. פעולה unsubscribeFromCampaigns. מעוזר AI: דרך API ולוח הבקרה בלבד: מכיל מידע סודי שאסור שיגיע למודל AI (מקבל אסימון הסרת הרשמה חתום של נמען).
• DELETE /v1/campaigns/{campaignId} — מחיקת קמפיין והוצאת שורות המסירה שלו משימוש. פעולה deleteCampaign. מעוזר AI: דרך API ולוח הבקרה בלבד: נדרשת הרשאה שאינה ניתנת לחיבורי AI (מחיקת קמפיין ESP דורשת את campaigns.send).
• GET /v1/campaigns/{campaignId} — קמפיין יחיד ודוח המסירה שלו. פעולה getCampaign. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/campaigns/{campaignId}/control — השהיה, חידוש או ביטול של שליחה פעילה. פעולה controlCampaign. מעוזר AI: ממשק API ולוח בקרה בלבד: פעולה זו כרוכה בעלות כספית או מנצלת מכסה, ולכן אדם לוחץ עליה (משהה/מחדש שליחה בזמן אמת).
• POST /v1/campaigns/{campaignId}/send — התחלת השליחה הרציפה. פעולה sendCampaign. מעוזר AI: ממשק API ולוח בקרה בלבד: פעולה זו כרוכה בעלות כספית או מנצלת מכסה, ולכן אדם לוחץ עליה (שולח קמפיין ESP לנמענים אמיתיים).
• POST /v1/campaigns/{campaignId}/test — שליחת הודעה אמיתית אחת בערוץ שבו הקמפיין ישתמש בפועל. פעולה testSendCampaign. מעוזר AI: ממשק API ולוח בקרה בלבד: פעולה זו דורשת הרשאה שאינה ניתנת לחיבורי AI (שליחת בדיקה ב-ESP דורשת את campaigns.send).

דפים ציבוריים ו-webhooks נכנסים

• GET /v1/public/email-marketing/c/{token} — מונה הלחיצות. מתעד לחיצה אחת לכל נמען ומפנה מחדש לקישור המקורי. פעולה emailMarketingClick. מעוזר AI: דף שהנמענים שלכם פותחים מתוך הודעת דוא"ל (ההפניה מחדש של מעקב הלחיצות).
• GET /v1/public/email-marketing/f/{public_id} — דף מאוחסן של טופס הרשמה (ללא התחברות). פעולה emailMarketingFormPage. מעוזר AI: דף שהנמענים שלכם פותחים מתוך הודעת דוא"ל (הדף הציבורי של טופס ההרשמה).
• POST /v1/public/email-marketing/f/{public_id} — שלח טופס הרשמה (דף מתארח, מוטמע או JSON). פעולה emailMarketingFormSubmit. מעוזר AI: נקרא על ידי מערכת אחרת (ספק או מבקר), לא על ידך (מבקר שולח טופס הרשמה).
• GET /v1/public/email-marketing/fc — דף אישור הרשמה כפולה (ללא התחברות). פעולה emailMarketingFormConfirmPage. מעוזר AI: דף שהנמענים שלך פותחים מאימייל (דף אישור ההרשמה הכפולה).
• POST /v1/public/email-marketing/fc — אשר הרשמה (מוסיף את האדם לרשימה עם תיעוד הסכמה). פעולה emailMarketingFormConfirm. מעוזר AI: נקרא על ידי מערכת אחרת (ספק או מבקר), לא על ידך (מבקר מאשר הרשמה כפולה).
• GET /v1/public/email-marketing/o/{token} — תמונת מעקב הפתיחה (GIF בגודל 1x1). סופר פתיחה אחת לכל נמען. פעולה emailMarketingOpenPixel. מעוזר AI: דף שהנמענים שלך פותחים מאימייל (פיקסל מעקב הפתיחה).
• GET /v1/public/email-marketing/u/{token} — קישור ביטול המנוי בכותרת התחתונה (ללא התחברות). פעולה emailMarketingUnsubscribePage. מעוזר AI: דף שהנמענים שלך פותחים מאימייל (דף ביטול המנוי).
• POST /v1/public/email-marketing/u/{token} — ביטול הרשמה בלחיצה אחת לפי RFC 8058 (וכפתור "עצור הכל" של הדף). פעולה emailMarketingUnsubscribeOneClick. מעוזר AI: נקרא על ידי מערכת אחרת (ספק או מבקר), לא על ידך (ביטול הרשמה בלחיצה אחת לפי RFC 8058).
• GET /v1/public/email-marketing/warmup-u/{token} — קישור ביטול ההרשמה של הודעת החימום עבור מאגר השיווק (ללא התחברות). פעולה emailMarketingWarmupUnsubscribePage. מעוזר AI: דף שהנמענים שלך פותחים מתוך הודעת דוא"ל (דף ביטול ההרשמה של החימום).
• POST /v1/public/email-marketing/warmup-u/{token} — ביטול הרשמה בלחיצה אחת לפי RFC 8058 מהודעת החימום. פעולה emailMarketingWarmupUnsubscribeOneClick. מעוזר AI: נקרא על ידי מערכת אחרת (ספק או מבקר), לא על ידך (ביטול הרשמה בלחיצה אחת של החימום).
• POST /v1/webhooks/campaign-events — קליטת אירוע מסירה חתום מספק הדוא"ל. פעולה receiveCampaignDeliveryWebhook. מעוזר AI: נקרא על ידי מערכת אחרת (ספק או מבקר), לא על ידך (webhook חתום של מסירת ESP).
• POST /v1/webhooks/campaigns/telnyx — תגובות SMS נכנסות (STOP / START) מספק ה-SMS שלנו. פעולה receiveCampaignsTelnyxInbound. מעוזר AI: נקרא על ידי מערכת אחרת (ספק או מבקר), לא על ידך (webhook נכנס חתום של Telnyx).
• POST /v1/webhooks/email-marketing/{connection_id} — אירועי מסירה של ספק הדוא"ל של הלקוח עצמו עבור חיבור שליחה אחד. פעולה receiveEmailMarketingProviderWebhook. מעוזר בינה מלאכותית: מופעל על ידי מערכת אחרת (ספק או מבקר), לא על ידכם (webhook חתום של שולח-ספק).

תהליכים

• GET /v1/email-marketing/flows — תהליכי דוא"ל (ברוכים הבאים, טפטוף, תאריך שנתי), עמוד keyset אחד. פעולה listEmailMarketingFlows. הרשאות שנבדקו: email_marketing.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• POST /v1/email-marketing/flows — יצירת תהליך (הוא מתחיל כטיוטה). פעולה createEmailMarketingFlow. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• DELETE /v1/email-marketing/flows/{flow_id} — מחיקת תהליך והרישומים שלו (ההרצות שנשלחו יישארו, כקמפיינים). פעולה deleteEmailMarketingFlow. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• GET /v1/email-marketing/flows/{flow_id} — תהליך אחד עם השלבים והדוח שלו (רשומים, בתהליך, הרצות ונמענים לכל שלב). פעולה getEmailMarketingFlow. הרשאות שנבדקו: email_marketing.view. מעוזר בינה מלאכותית: כן, דרך ה-MCP.
• PATCH /v1/email-marketing/flows/{flow_id} — שינוי תהליך (flow); steps, כאשר מצוין, מחליף את הרצף כולו. פעולה updateEmailMarketingFlow. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/email-marketing/flows/{flow_id}/activate — הפעלת תהליך (flow); רק אנשים שמצטרפים לרשימה מעתה ואילך יצורפו. פעולה activateEmailMarketingFlow. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: כן, דרך ה-MCP.
• POST /v1/email-marketing/flows/{flow_id}/pause — השהיית תהליך (flow); שלבים שהגיע זמנם ממתינים ואף אדם חדש אינו מקבל דוא"ל עד להפעלתו מחדש. פעולה pauseEmailMarketingFlow. הרשאות שנבדקו: email_marketing.manage, email_marketing.view. מעוזר AI: כן, דרך ה-MCP.