Рассылки
Кампании: создание черновика, запуск, статистика, получатели.
public_campaigns_list
читает
Список рассылок. Архивные по умолчанию скрыты.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
page | int | — | с 1 |
limit | int | — | 1–100 |
name | string | — | поиск по подстроке названия |
status | string[] | — | draft · built · scheduled · in_progress · paused · completed · banned · on_hold |
archived | bool | — | true — только архив |
withStats | bool | — | добавить статистику к каждой |
public_campaigns_get_by_id
читает
Одна рассылка. Для составных отдаёт структуру: abTest с вариантами и победителем, followUp, parent у части, totalStats по всей семье.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
campaignId | int | да | — |
withStats | bool | — | — |
public_campaigns_create
меняет данные
Создаёт черновик. Все поля необязательны при создании, обязательные проверяются при запуске. abTest превращает рассылку в сплит-тест по темам (2–10 вариантов).
public_campaigns_update
меняет данные
Правит черновик. Только в статусе DRAFT, меняются лишь переданные поля. abTest.variants заменяет весь набор вариантов целиком.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
campaignId | int | да | — |
name | string | — | — |
subject | string | — | — |
previewTitle | string | — | — |
senderId | number | — | — |
senderName | string | — | — |
templateId | number | — | — |
listIds | number[] | — | — |
segmentId | number | — | — |
attachments | number[] | — | — |
abTest | object | — | — |
public_campaigns_delete
отправляет письма / необратимо
Удаляет черновик вместе с его шаблоном. Только DRAFT. Через API не отменяется.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
campaignId | int | да | — |
public_campaigns_schedule
отправляет письма / необратимо
Запускает черновик: модерация, затем отправка — сразу или в указанное время. Требует шаблон, отправителя, тему и хотя бы один список; у A/B ещё и abTest.percent. followUp и chunkSettings взаимоисключающие и недоступны для A/B.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
campaignId | int | да | — |
scheduledStartDate | string | — | ISO 8601, не в прошлом |
followUp | object | — | subject + offsetHours (минимум 24) — досыл неоткрывшим |
chunkSettings | object | — | initialChunkSize + increaseChunkSizePercent — отправка порциями по дням |
public_campaigns_archive
меняет данные
В архив. Только COMPLETED или BANNED; у A/B и follow-up архивируется вся семья.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
campaignId | int | да | — |
public_campaigns_unarchive
меняет данные
Из архива. Тоже всей семьёй.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
campaignId | int | да | — |
public_campaigns_recipients
читает
Поимённый список получателей с фильтром по статусу. Единственный способ выгрузить адреса. Точного числа страниц нет — только hasMore.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
campaignId | int | да | — |
page | int | — | — |
limit | int | — | 1–100 |
status | string[] | — | delivered · opened · clicked · unsubscribed · complaint · error · soft_bounced · hard_bounced · error_infrastructure · not_delivered |
public_campaigns_get_activity
читает
Открытия и клики по временным отрезкам. Агрегат, адресов не отдаёт.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
campaignId | int | да | — |
public_campaigns_get_link_clicks
читает
Клики в разрезе ссылок письма.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
campaignId | int | да | — |
public_campaigns_get_stats_by_domains
читает
Статистика в разрезе почтовых систем получателей.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
campaignId | int | да | — |
public_campaigns_ab_test_preview
читает
Считает, как разделится база при заданном проценте теста: сколько контактов на вариант и сколько получит победителя. Ничего не меняет.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
campaignId | int | да | — |
percent | number | — | 1–99, по умолчанию 10 |
public_campaigns_chunks_preview
читает
Считает разбивку на дневные порции: сколько порций, по сколько контактов и в какие даты. Ничего не меняет.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
campaignId | int | да | — |
initialChunkSize | number | да | минимум 1 |
increaseChunkSizePercent | number | — | без него — равные порции |
scheduledStartDate | string | — | ISO 8601 |
Папки рассылок
Группировка кампаний. Рассылка может лежать только в одной папке.
public_folders_list
читает
Список папок.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
page | int | — | — |
limit | int | — | 1–100 |
q | string | — | поиск по названию |
public_folders_get_by_id
читает
Одна папка.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
folderId | int | да | — |
public_folders_create
меняет данные
Создаёт папку.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
name | string | да | до 200 символов |
public_folders_update
меняет данные
Переименовывает папку.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
folderId | int | да | — |
name | string | — | — |
public_folders_delete
меняет данные
Мягко удаляет папку. Рассылки не удаляются, только отвязываются.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
folderId | int | да | — |
public_folders_campaigns_add
меняет данные
Кладёт рассылки в папку. Рассылка может быть только в одной папке, поэтому добавление её переносит. Несуществующие id молча игнорируются; в affectedCampaigns — сколько реально добавлено.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
folderId | int | да | — |
campaignIds | number[] | да | — |
public_folders_campaigns_remove
меняет данные
Убирает рассылки из папки, не удаляя их.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
folderId | int | да | — |
campaignIds | number[] | да | — |
Контакты
Контакт живёт в аккаунте, а не в списке: он может состоять сразу в нескольких списках.
public_contacts_list
читает
Поиск контактов по всему аккаунту.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
page | int | — | — |
limit | int | — | 1–100 |
email | string | — | точное совпадение |
listId | number | — | — |
status | string[] | — | new · active · unsubscribed · unsubscribed_by_us · soft_bounced · hard_bounced · error · complaint |
sortBy | enum | — | id · email · createdAt · updatedAt · lastActivityAt |
sortDir | enum | — | asc · desc |
public_contacts_get_by_id
читает
Один контакт.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
contactId | int | да | — |
public_contacts_update
меняет данные
Меняет имя и телефон контакта.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
contactId | int | да | — |
name | string | — | — |
phone | string | — | — |
public_contacts_delete
отправляет письма / необратимо
Насовсем удаляет контакт из всех списков.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
contactId | int | да | — |
public_contacts_bulk_delete
отправляет письма / необратимо
Массовое удаление, 1–1000 id за раз. Необратимо.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
contactIds | number[] | да | 1–1000 |
public_contacts_statistics
читает
Агрегат по контактам; с listId — в пределах списка.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
listId | number | — | — |
public_contacts_unsubscribe
меняет данные
Отписывает контакт глобально.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
contactId | int | да | — |
public_contacts_subscribe_back
меняет данные
Возвращает подписку ранее отписавшемуся.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
contactId | int | да | — |
public_contacts_remove_from_all_lists
меняет данные
Выкидывает контакты из всех списков, сами контакты остаются. 1–1000 id.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
contactIds | number[] | да | 1–1000 |
public_contacts_api_sending_history
читает
История транзакционных писем этому контакту.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
contactId | int | да | — |
page | int | — | — |
limit | int | — | 1–100 |
public_contacts_distribution_sending_history
читает
История массовых рассылок этому контакту.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
contactId | int | да | — |
page | int | — | — |
limit | int | — | 1–100 |
Списки контактов
Список — контейнер адресов. Переменные определяются на уровне списка.
public_lists_list
читает
Все списки аккаунта с числом контактов.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
page | int | — | — |
limit | int | — | 1–100 |
q | string | — | поиск по названию |
status | enum | — | enabled · disabled |
sortBy | enum | — | id · name · createdAt · updatedAt |
sortDir | enum | — | asc · desc |
public_lists_get_by_id
читает
Один список.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
listId | int | да | — |
public_lists_create
меняет данные
Создаёт список.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
name | string | да | — |
public_lists_update
меняет данные
Переименовывает список или включает/выключает его.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
listId | int | да | — |
name | string | — | — |
status | enum | — | enabled · disabled |
public_lists_delete
меняет данные
Мягкое удаление списка.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
listId | int | да | — |
public_lists_statistics
читает
Статистика контактов внутри списка.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
listId | int | да | — |
public_lists_contacts_list
читает
Контакты списка вместе со значениями переменных.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
listId | int | да | — |
page | int | — | — |
limit | int | — | 1–100 |
email | string | — | точное |
status | string[] | — | те же 8 статусов контакта |
sortBy | enum | — | — |
sortDir | enum | — | — |
public_lists_contacts_create
меняет данные
Создаёт контакт или переиспользует существующий: поиск по email внутри аккаунта. Если такой email уже есть — имя и телефон из запроса игнорируются, переменные применяются в обоих случаях. Дубль никогда не ошибка, различить по флагу created.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
listId | int | да | — |
email | string | да | — |
name | string | — | — |
phone | string | — | — |
variables | object | — | ключ → значение |
public_lists_contacts_add
меняет данные
Добавляет в список уже существующие контакты. Недоступные id молча игнорируются; в affectedContacts — сколько реально добавлено (уже состоявшие не считаются).
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
listId | int | да | — |
contactIds | number[] | да | — |
public_lists_contacts_import
меняет данные
Импорт до 1000 контактов за вызов. Незнакомые ключи переменных нужно объявить в variables, иначе они не создадутся.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
listId | int | да | — |
rows | object[] | да | до 1000: email, name, phone, variables |
updateExisting | bool | — | по умолчанию false |
variables | object[] | — | key + name + type (string · phone) |
public_lists_contacts_update
меняет данные
Правит контакт в контексте списка, включая переменные. null сбрасывает значение.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
listId | int | да | — |
contactId | int | да | — |
name | string | — | — |
phone | string | — | — |
variables | object | — | — |
public_lists_contacts_move
меняет данные
Атомарно переносит контакты в другой список. Переносятся только те, кто реально состоит в исходном; уже находящиеся в целевом считаются перенесёнными.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
listId | int | да | откуда |
toListId | number | да | куда, обязан отличаться |
contactIds | number[] | да | — |
public_lists_contacts_remove
меняет данные
Убирает контакты из списка, не удаляя их из аккаунта.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
listId | int | да | — |
contactIds | number[] | да | — |
Сегменты
Динамическая выборка по условиям. Размер сегмента через API не читается.
public_segments_list
читает
Сегменты с их условиями.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
page | int | — | — |
limit | int | — | 1–100 |
name | string | — | подстрока, без учёта регистра |
public_segments_get_by_id
читает
Сегмент со всеми условиями.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
segmentId | int | да | — |
public_segments_create
меняет данные
Создаёт сегмент с произвольным набором условий.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
name | string | да | — |
applyConditionsType | enum | — | and (по умолчанию) · or |
conditions | object[] | — | field + operator + value; для field=variable нужен variableId |
public_segments_update
меняет данные
Правит сегмент. Если передать conditions — весь набор заменяется целиком; если не передать — условия не трогаются.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
segmentId | int | да | — |
name | string | — | — |
applyConditionsType | enum | — | — |
conditions | object[] | — | — |
public_segments_list_filters
читает
Какие поля доступны для условий, включая переменные контактов, и какие операторы к каждому применимы.
Без параметров.
Переменные
Пользовательские поля контакта. Определяются в пределах списка.
public_variables_list
читает
Определения переменных списка.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
listId | int | да | — |
public_variables_create
меняет данные
Создаёт переменную.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
listId | int | да | — |
key | string | да | строчные буквы, цифры, подчёркивания; начинается с буквы; до 50 |
name | string | да | до 50 |
type | enum | — | string (по умолчанию) · phone |
defaultValue | string | — | — |
public_variables_update
меняет данные
Меняет отображаемое имя и значение по умолчанию.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
listId | int | да | — |
variableId | int | да | — |
name | string | — | — |
defaultValue | string | — | null очищает |
public_variables_delete
отправляет письма / необратимо
Удаляет переменную вместе со всеми её значениями.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
listId | int | да | — |
variableId | int | да | — |
Транзакционные письма и ключи
Отправка по SMTP/API-ключу. Ключ привязан к подтверждённому домену.
public_external_mail_keys_list
читает
Ключи отправки аккаунта.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
page | int | — | — |
limit | int | — | 1–100 |
public_external_mail_keys_get_by_id
читает
Один ключ.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
keyId | int | да | — |
public_external_mail_keys_create
меняет данные
Создаёт ключ для подтверждённого домена. Создаётся в статусе DISABLED и включается после модерации платформой.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
name | string | да | — |
domainId | number | да | — |
public_external_mail_keys_update
меняет данные
Переименовывает ключ.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
keyId | int | да | — |
name | string | — | до 245 |
public_external_mail_keys_delete
отправляет письма / необратимо
Удаляет ключ. Отправка по нему прекращается немедленно, отменить через API нельзя.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
keyId | int | да | — |
public_external_mail_key_stats
читает
Агрегат по ключу за период (по предрассчитанным дневным данным). Без дат — последние 30 суток.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
keyId | int | да | — |
dateFrom | string | — | YYYY-MM-DD |
dateTo | string | — | YYYY-MM-DD |
public_external_mails_list
читает
Все транзакционные письма аккаунта, от свежих к старым. Точного числа страниц нет — только hasMore. Фильтра по теме нет.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
page | int | — | — |
limit | int | — | 1–100 |
keyId | number | — | — |
status | string[] | — | delivered · opened · clicked · unsubscribed · complaint · error · soft_bounced · hard_bounced · sending · pending |
dateFrom | string | — | YYYY-MM-DD |
dateTo | string | — | YYYY-MM-DD |
toEmail | string | — | частичное совпадение |
fromEmail | string | — | точное |
public_external_mail_send
отправляет письма / необратимо
Отправляет письмо по ключу. Нужен html и/или text — хотя бы одно. Ключ выбирать по домену адреса в mail.from.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
key_id | number | да | — |
mail.to | object | да | email + name |
mail.from | object | да | email + name |
mail.subject | string | да | — |
mail.html | string | — | html или text обязателен |
mail.text | string | — | — |
mail.previewTitle | string | — | — |
mail.cc | string | — | — |
mail.bcc | string | — | — |
mail.headers | object | — | — |
public_external_mail_send_by_template
отправляет письма / необратимо
То же, но письмо собирается из сохранённого шаблона: id в mail.idTemplateMailUser, подстановки в mail.params.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
key_id | number | да | — |
mail.to | object | да | — |
mail.from | object | да | — |
mail.subject | string | да | — |
mail.idTemplateMailUser | number | да | — |
mail.params | object | — | подстановки |
mail.previewTitle | string | — | — |
mail.cc | string | — | — |
mail.bcc | string | — | — |
mail.headers | object | — | — |
Цепочки
Автоматические сценарии. Через MCP доступен только запуск.
public_chains_trigger
отправляет письма / необратимо
Запускает активную цепочку для контакта по её webhook-токену. Поля data кроме email и name сохраняются как свойства контакта.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
webhookToken | string | да | — |
email | string | да | — |
name | string | — | — |
Домены
Домены отправки и их DNS-записи.
public_domains_list
читает
Домены аккаунта вместе с DNS-записями.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
page | int | — | — |
limit | int | — | 1–100 |
public_domains_get_by_id
читает
Один домен с записями.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
domainId | int | да | — |
public_domains_create
меняет данные
Добавляет домен и генерирует записи DKIM, SPF, DMARC, которые нужно прописать в DNS-зоне. После этого запустить проверку.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
name | string | да | например example.com |
public_domains_verify
меняет данные
Проверяет DNS: резолвит и валидирует DKIM, SPF, DMARC, обновляет статус. Может вернуть предупреждения (например, несколько SPF-записей) и предложить объединённую SPF.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
domainId | int | да | — |
public_domains_delete
меняет данные
Удаляет неподтверждённый домен. Подтверждённый удалить через API нельзя — на нём висят ключи и отправители.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
domainId | int | да | — |
Отправители
Адреса в поле From. Подтверждаются письмом.
public_senders_list
читает
Отправители аккаунта.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
page | int | — | — |
limit | int | — | 1–100 |
verified | enum | — | enabled · disabled |
public_senders_get_by_id
читает
Один отправитель.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
senderId | int | да | — |
public_senders_create
отправляет письма / необратимо
Добавляет адрес отправителя. На адрес всегда уходит письмо с подтверждением; отправитель становится подтверждённым только после клика по ссылке. Адреса на своём подтверждённом домене доставляются лучше.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
email | string | да | — |
public_senders_resend_confirmation
отправляет письма / необратимо
Повторно шлёт письмо с подтверждением на неподтверждённый адрес.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
senderId | int | да | — |
Шаблоны
HTML-шаблоны писем. Шаблоны из конструктора править нельзя.
public_templates_list_v2
читает
Шаблоны аккаунта.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
page | int | — | — |
limit | int | — | 1–100 |
name | string | — | подстрока |
public_templates_list
читает · устарело
То же, устаревшая версия. Использовать v2.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
page | int | — | — |
limit | int | — | 1–100 |
name | string | — | — |
public_templates_get_by_id
читает
Шаблон вместе с HTML.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
templateId | int | да | — |
public_templates_create
меняет данные
Создаёт HTML-шаблон (type=html).
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
name | string | да | — |
html | string | да | — |
text | string | — | текстовая версия |
public_templates_update
меняет данные
Правит HTML-шаблон. Шаблоны конструктора (type=builder) править запрещено.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
templateId | int | да | — |
name | string | — | — |
html | string | — | — |
text | string | — | — |
Вебхуки
Уведомления о событиях. Удаления через MCP нет — только отключение статусом.
public_webhooks_list
читает
Вебхуки аккаунта.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
page | int | — | — |
limit | int | — | 1–100 |
public_webhooks_get_by_id
читает
Один вебхук.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
webhookId | int | да | — |
public_webhooks_create
меняет данные
Создаёт вебхук. Нужен хотя бы один триггер.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
name | string | да | — |
url | string | да | до 2048 |
triggers | string[] | да | 22 события, см. ниже |
status | enum | — | enabled (по умолчанию) · disabled |
public_webhooks_update
меняет данные
Частично правит вебхук. Переданный triggers заменяет список событий целиком.
| Параметр | Тип | Обяз. | Значения |
|---|---|---|---|
webhookId | int | да | — |
name | string | — | — |
url | string | — | — |
triggers | string[] | — | — |
status | enum | — | — |
Дата публикации: 1 сентября 2026