Усе, що ви можете робити на панелі керування в Zinn® Campaigns, ви також можете робити через API, а більшість із цього — за допомогою ШІ-асистента, підключеного до вашого облікового запису через 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.
Приклад: та сама чернетка від штучного інтелекту-помічника
Попросіть свого помічника простими словами, наприклад: "Створи чернетку листа Zinn® Campaigns із назвою Весняний розпродаж і темою 'Наш весняний розпродаж розпочинається сьогодні'". У фоновому режимі він знаходить операцію за допомогою 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, написання текстів за кредити штучного інтелекту, реєстрація для відправлення повідомлень у 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 кількість секунд.
Вебхуки
Результати доставки надходять до Zinn® Campaigns від провайдера, який надсилає вашу електронну пошту:
- З власним провайдером (наприклад, Resend), збережіть його секретний ключ підпису вебхука в з'єднанні відправлення на панелі керування (Кампанії → Відправлення). Ви отримаєте
webhook_url; спрямуйте на нього події доставки, повернення та скарг провайдера. Повернення або скарга на спам негайно вилучає адресу з майбутніх відправлень.
- З відправленням через Zinn® налаштовувати нічого не потрібно.
Переглядайте результати за допомогою операцій зі звітами (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).
Усі операції з Кампаніями
Огляд
GET /v1/email-marketing — Огляд Zinn® Campaigns для однієї організації. Операція getEmailMarketingOverview. Перевірені дозволи: email_marketing.view. Зі штучного інтелекту-помічника: так, через MCP.
Електронні кампанії
GET /v1/email-marketing/campaigns — Електронні кампанії, спочатку новіші, одна сторінка keyset. Операція listEmailMarketingCampaigns. Перевірені дозволи: email_marketing.view. Від ШІ-асистента: так, через MCP.
POST /v1/email-marketing/campaigns — Створити чернетку електронної кампанії. Операція createEmailMarketingCampaign. Перевірені дозволи: email_marketing.manage, email_marketing.view. Від ШІ-асистента: так, через MCP.
GET /v1/email-marketing/campaigns/{campaign_id} — Одна електронна кампанія. Операція getEmailMarketingCampaign. Перевірені дозволи: email_marketing.view. Від ШІ-асистента: так, через MCP.
PATCH /v1/email-marketing/campaigns/{campaign_id} — Редагувати чернетку (або відхилену кампанію, яка повертається до стану чернетки). Операція updateEmailMarketingCampaign. Перевірені дозволи: email_marketing.manage, email_marketing.view. Від ШІ-асистента: так, через MCP.
GET /v1/email-marketing/campaigns/{campaign_id}/lint — Перевірити текст кампанії на проблеми з доставкою перед її надсиланням. Операція lintEmailMarketingCampaign. Перевірені дозволи: email_marketing.view. Від ШІ-асистента: так, через MCP.
GET /v1/email-marketing/campaigns/{campaign_id}/report — Показники кампанії. Операція getEmailMarketingCampaignReport. Перевірені дозволи: email_marketing.view. Від ШІ-асистента: так, через 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. Від ШІ-асистента: Лише API та панель керування: витрачає кошти або ліміт, тому кнопку має натиснути людина (написання за допомогою ШІ витрачає кредити ШІ).
Бренд-кіт
GET /v1/email-marketing/brand-kit — Бренд-кіт організації (назва, логотип, кольори, шрифт, стиль спілкування). Операція getEmailMarketingBrandKit. Перевірені дозволи: email_marketing.view. Від ШІ-асистента: Так, через MCP.
PUT /v1/email-marketing/brand-kit — Редагувати бренд-кіт. Операція updateEmailMarketingBrandKit. Перевірені дозволи: email_marketing.manage, email_marketing.view. Від ШІ-асистента: Так, через MCP.
POST /v1/email-marketing/brand-kit/read — Зчитати бренд-кіт із вебсайту організації. Операція readEmailMarketingBrandKit. Перевірені дозволи: email_marketing.manage, email_marketing.view. Від ШІ-асистента: Так, через MCP.
Контакти та разові повідомлення
GET /v1/email-marketing/contacts — Контакти організації, по одній сторінці keyset за раз. Операція listEmailMarketingContacts. Перевірені дозволи: email_marketing.view. Зі штучного інтелекту: так, через MCP.
POST /v1/email-marketing/contacts/{contact_id}/messages — Надіслати одне SMS-повідомлення одному контакту, сплачене з кредитного балансу Zinn®. Операція sendEmailMarketingMessage. Перевірені дозволи: email_marketing.manage, email_marketing.view. Зі штучного інтелекту: лише через API та інформаційну панель: дія списує кошти або ліміт, тому її має підтверджувати людина (одноразове повідомлення контакту витрачає ліміт).
GET /v1/email-marketing/messages — Повідомлення SMS та WhatsApp, надіслані організацією, спочатку найновіші, одна сторінка keyset. Операція listEmailMarketingMessages. Перевірені дозволи: email_marketing.view. Зі штучного інтелекту: так, через 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 — Додати контакти до списку за адресою електронної пошти (не більше 1000 за запит). Операція 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 — Форми реєстрації (подвійне підтвердження), спочатку найновіші, одна сторінка набору ключів. Операція listEmailMarketingForms. Перевірені дозволи: email_marketing.view. Від ШІ-асистента: так, через MCP.
POST /v1/email-marketing/forms — Створити форму реєстрації, яка додає підтверджених користувачів до одного списку. Операція createEmailMarketingForm. Перевірені дозволи: email_marketing.manage, email_marketing.view. Від ШІ-асистента: так, через MCP.
DELETE /v1/email-marketing/forms/{form_id} — Видалити форму реєстрації (вже підтверджені користувачі залишаються у списку). Операція deleteEmailMarketingForm. Перевірені дозволи: email_marketing.manage, email_marketing.view. Від ШІ-асистента: так, через MCP.
PATCH /v1/email-marketing/forms/{form_id} — Змінити форму реєстрації (текст, список, перенаправлення, увімкнено або вимкнено). Операція updateEmailMarketingForm. Перевірені дозволи: email_marketing.manage, email_marketing.view. Від ШІ-асистента: так, через 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 — Зберегти секретний ключ підпису вебхука вашого постачальника електронної пошти для цього з’єднання. Операція setEmailMarketingSenderWebhook. Перевірені дозволи: email_marketing.manage, email_marketing.view. З AI-асистента: викликається іншою системою (постачальником або відвідувачем), а не вами (зберігає секретний ключ вебхука постачальника).
SMS та WhatsApp
GET /v1/email-marketing/sms — Що потрібно екрану SMS — відкрито?, призупинено?, баланс кредитів і ціни. Операція getEmailMarketingSms. Перевірені дозволи: email_marketing.view. Від AI-асистента: так, через MCP.
GET /v1/email-marketing/sms/campaigns — Масові SMS-кампанії, спочатку новіші, одна сторінка keyset. Операція listSmsMarketingCampaigns. Перевірені дозволи: email_marketing.view. Від AI-асистента: так, через MCP.
POST /v1/email-marketing/sms/campaigns — Створити чернетку SMS для списку. Операція createSmsMarketingCampaign. Перевірені дозволи: email_marketing.manage, email_marketing.view. Від AI-асистента: так, через MCP.
GET /v1/email-marketing/sms/campaigns/{campaign_id} — Одна масова SMS-кампанія. Операція getSmsMarketingCampaign. Перевірені дозволи: email_marketing.view. Від AI-асистента: так, через MCP.
PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — Редагувати чернетку (або відхилену кампанію, яка повертається до стану чернетки). Операція updateSmsMarketingCampaign. Перевірені дозволи: email_marketing.manage, email_marketing.view. Від AI-асистента: так, через MCP.
GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — Показники масової SMS-кампанії. Операція getSmsMarketingCampaignReport. Перевірені дозволи: email_marketing.view. Від AI-асистента: так, через MCP.
POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — Почати надсилання SMS усім у списку, хто погодився на отримання SMS, або відновити кампанію, призупинену через нестачу коштів. Операція sendSmsMarketingCampaign. Перевірені дозволи: email_marketing.manage, email_marketing.view. Від ШІ-асистента: Лише API та панель керування: витрачає кошти або ліміт, тому кнопку має натискати людина (надсилає платні повідомлення SMS/WhatsApp).
GET /v1/email-marketing/sms/registrations/us — Реєстрація US 10DLC цієї організації та її вартість. Операція getEmailMarketingUsRegistration. Перевірені дозволи: email_marketing.view. Від ШІ-асистента: Так, через MCP.
POST /v1/email-marketing/sms/registrations/us — Надіслати бренд і кампанію цієї організації для US 10DLC (оплата стягується під час подання). Операція submitEmailMarketingUsRegistration. Перевірені дозволи: email_marketing.manage, email_marketing.view. Від ШІ-асистента: Лише API та панель керування: витрачає кошти або ліміт, тому кнопку має натискати людина (реєстрація US 10DLC передбачає збори оператора).
Кампанії через власну службу електронної пошти (шаблони, сегменти, придушення)
GET /v1/campaigns — Кампанії організації. Операція listCampaigns. Від ШІ-асистента: Так, через MCP.
POST /v1/campaigns — Створити кампанію на основі шаблону й аудиторії. Операція createCampaign. Від ШІ-асистента: Так, через MCP.
DELETE /v1/campaigns/esp — Від'єднати обліковий запис провайдера та видалити його збережений ключ. Операція disconnectEsp. З боку ШІ-асистента: Лише API та панель керування: містить секретні дані, які в жодному разі не повинні потрапити до моделі ШІ (знищує збережений ключ ESP).
GET /v1/campaigns/esp — Власний обліковий запис провайдера електронної пошти організації. Операція getEspConnection. З боку ШІ-асистента: Так, через MCP.
POST /v1/campaigns/esp — Під'єднати обліковий запис провайдера електронної пошти. Операція connectEsp. З боку ШІ-асистента: Лише API та панель керування: містить секретні дані, які в жодному разі не повинні потрапити до моделі ШІ (тілом запиту є ключ API ESP).
POST /v1/campaigns/esp/verify — Перевірити працездатність облікового запису провайдера та зчитати його підтверджені домени. Операція verifyEspConnection. З боку ШІ-асистента: Лише API та панель керування: містить секретні дані, які в жодному разі не повинні потрапити до моделі ШІ (повторно перевіряє збережений ключ ESP).
POST /v1/campaigns/preview — Render шаблону зі зразками значень. Операція previewCampaignTemplate. З боку ШІ-асистента: Так, через MCP.
GET /v1/campaigns/segments — Ваші збережені сегменти аудиторії. Операція listCampaignSegments. Перевірені дозволи: campaigns.view. З боку ШІ-асистента: Так, через MCP.
POST /v1/campaigns/segments — Зберегти новий сегмент аудиторії. Операція createCampaignSegment. Перевірені дозволи: campaigns.manage. З боку ШІ-асистента: Так, через 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 — Палітра магічних тегів, яку пропонує редактор кампаній. Операція listCampaignTags. З ШІ-асистента: так, через MCP.
GET /v1/campaigns/templates — Шаблони кампаній організації. Операція listCampaignTemplates. З ШІ-асистента: так, через MCP.
POST /v1/campaigns/templates — Створити шаблон кампанії. Операція createCampaignTemplate. З ШІ-асистента: так, через MCP.
DELETE /v1/campaigns/templates/{templateId} — Архівувати шаблон і вилучити джерела його перекладу. Операція archiveCampaignTemplate. З ШІ-асистента: так, через MCP.
GET /v1/campaigns/templates/{templateId} — Один шаблон кампанії. Операція getCampaignTemplate. З ШІ-асистента: так, через MCP.
PUT /v1/campaigns/templates/{templateId} — Редагувати шаблон кампанії. Операція updateCampaignTemplate. З ШІ-асистента: так, через MCP.
POST /v1/campaigns/unsubscribe — Залишити маркетинговий список. Обліковий запис не потрібен. Операція unsubscribeFromCampaigns. З ШІ-асистента: лише API та інформаційна панель: містить секрет, який ніколи не повинен потрапляти до моделі ШІ (приймає підписаний токен скасування підписки одержувача).
DELETE /v1/campaigns/{campaignId} — Видалити кампанію та вилучити її рядки доставки. Операція deleteCampaign. З ШІ-асистента: лише API та інформаційна панель: потрібен дозвіл, який не надається підключенням ШІ (для видалення кампанії ESP потрібен campaigns.send).
GET /v1/campaigns/{campaignId} — Одна кампанія та звіт про її доставку. Операція getCampaign. Від ШІ-асистента: так, через MCP.
POST /v1/campaigns/{campaignId}/control — Призупинити, відновити або скасувати поточне надсилання. Операція controlCampaign. Від ШІ-асистента: лише через API та інформаційну панель: дія витрачає кошти або ліміт, тому її має підтверджувати людина (призупиняє/відновлює активне надсилання).
POST /v1/campaigns/{campaignId}/send — Запустити тривале надсилання. Операція sendCampaign. Від ШІ-асистента: лише через API та інформаційну панель: дія витрачає кошти або ліміт, тому її має підтверджувати людина (надсилає кампанію ESP реальним одержувачам).
POST /v1/campaigns/{campaignId}/test — Надіслати одне справжнє повідомлення через канал, який фактично використовуватиме кампанія. Операція testSendCampaign. Від ШІ-асистента: лише через API та інформаційну панель: потрібен дозвіл, який не надається ШІ-підключенням (для тестового надсилання ESP потрібен campaigns.send).
Загальнодоступні сторінки та вхідні вебхуки
GET /v1/public/email-marketing/c/{token} — Лічильник кліків. Фіксує один клік на одного одержувача та перенаправляє на вихідне посилання. Операція emailMarketingClick. Від ШІ-асистента: сторінка, яку ваші одержувачі відкривають з електронного листа (перенаправлення для відстеження кліків).
GET /v1/public/email-marketing/f/{public_id} — Розміщена сторінка форми реєстрації (без входу). Операція emailMarketingFormPage. Від ШІ-асистента: сторінка, яку ваші одержувачі відкривають з електронного листа (загальнодоступна сторінка форми реєстрації).
POST /v1/public/email-marketing/f/{public_id} — Надіслати форму реєстрації (розміщена сторінка, вбудована або JSON). Операція emailMarketingFormSubmit. Від штучного інтелекту: викликається іншою системою (провайдером або відвідувачем), а не вами (відвідувач надсилає форму реєстрації).
GET /v1/public/email-marketing/fc — Сторінка підтвердження подвійної згоди (double opt-in) (вхід не потрібен). Операція emailMarketingFormConfirmPage. Від штучного інтелекту: сторінка, яку ваші одержувачі відкривають з електронного листа (сторінка підтвердження подвійної згоди).
POST /v1/public/email-marketing/fc — Підтвердити реєстрацію (додає особу до списку із записом про згоду). Операція emailMarketingFormConfirm. Від штучного інтелекту: викликається іншою системою (провайдером або відвідувачем), а не вами (відвідувач підтверджує подвійну згоду).
GET /v1/public/email-marketing/o/{token} — Зображення відстеження відкриттів (GIF 1x1). Рахує одне відкриття на отримувача. Операція emailMarketingOpenPixel. Від штучного інтелекту: сторінка, яку ваші одержувачі відкривають з електронного листа (піксель відстеження відкриттів).
GET /v1/public/email-marketing/u/{token} — Посилання для скасування підписки у нижньому колонтитулі (вхід не потрібен). Операція emailMarketingUnsubscribePage. Від штучного інтелекту: сторінка, яку ваші одержувачі відкривають з електронного листа (сторінка скасування підписки).
POST /v1/public/email-marketing/u/{token} — скасування підписки в один клік згідно з RFC 8058 (і кнопка сторінки «зупинити все»). Операція emailMarketingUnsubscribeOneClick. Від штучного інтелекту: викликається іншою системою (провайдером або відвідувачем), а не вами (скасування підписки в один клік за RFC 8058).
GET /v1/public/email-marketing/warmup-u/{token} — посилання для скасування підписки з розігрівального листа пулу маркетингу (без входу). Операція emailMarketingWarmupUnsubscribePage. Від штучного інтелекту: сторінка, яку ваші одержувачі відкривають з електронного листа (сторінка скасування підписки на розігрів).
POST /v1/public/email-marketing/warmup-u/{token} — скасування підписки в один клік за RFC 8058 з розігрівального листа. Операція emailMarketingWarmupUnsubscribeOneClick. Від штучного інтелекту: викликається іншою системою (провайдером або відвідувачем), а не вами (скасування підписки на розігрів в один клік).
POST /v1/webhooks/campaign-events — обробка підписаної події доставки від постачальника послуг електронної пошти. Операція receiveCampaignDeliveryWebhook. Від штучного інтелекту: викликається іншою системою (провайдером або відвідувачем), а не вами (підписаний вебхук доставки ESP).
POST /v1/webhooks/campaigns/telnyx — вхідні SMS-відповіді (STOP / START) від нашого постачальника SMS. Операція receiveCampaignsTelnyxInbound. Від штучного інтелекту: викликається іншою системою (провайдером або відвідувачем), а не вами (підписаний вхідний вебхук Telnyx).
POST /v1/webhooks/email-marketing/{connection_id} — Події доставки власного постачальника електронної пошти клієнта для одного з'єднання надсилання. Операція receiveEmailMarketingProviderWebhook. Від AI-асистента: викликається іншою системою (постачальником або відвідувачем), а не вами (підписаний вебхук відправника-постачальника).
Потоки
GET /v1/email-marketing/flows — Потоки електронних листів (вітальні, крапельні, щорічна дата), одна сторінка keyset. Операція listEmailMarketingFlows. Перевірені дозволи: email_marketing.view. Від AI-асистента: так, через MCP.
POST /v1/email-marketing/flows — Створити потік (починається як чернетка). Операція createEmailMarketingFlow. Перевірені дозволи: email_marketing.manage, email_marketing.view. Від AI-асистента: так, через MCP.
DELETE /v1/email-marketing/flows/{flow_id} — Видалити потік та його реєстрації (надіслані запуски залишаються як кампанії). Операція deleteEmailMarketingFlow. Перевірені дозволи: email_marketing.manage, email_marketing.view. Від AI-асистента: так, через MCP.
GET /v1/email-marketing/flows/{flow_id} — Один потік з його кроками та звітом (зареєстровані, у процесі, запуски та одержувачі на кожен крок). Операція getEmailMarketingFlow. Перевірені дозволи: email_marketing.view. Від AI-асистента: так, через MCP.
PATCH /v1/email-marketing/flows/{flow_id} — Змінити ланцюжок; параметр steps, якщо вказаний, замінює всю послідовність. Операція updateEmailMarketingFlow. Перевірені дозволи: email_marketing.manage, email_marketing.view. Через ШІ-асистента: так, через MCP.
POST /v1/email-marketing/flows/{flow_id}/activate — Увімкнути ланцюжок; додаються лише ті користувачі, які приєднаються до списку відтепер. Операція activateEmailMarketingFlow. Перевірені дозволи: email_marketing.manage, email_marketing.view. Через ШІ-асистента: так, через MCP.
POST /v1/email-marketing/flows/{flow_id}/pause — Призупинити ланцюжок; заплановані кроки очікують, і нові листи нікому не надсилаються, доки його знову не ввімкнуть. Операція pauseEmailMarketingFlow. Перевірені дозволи: email_marketing.manage, email_marketing.view. Через ШІ-асистента: так, через MCP.