Основная информация про MCP

Быстрый старт: что, как, зачем


Рассылки

Кампании: создание черновика, запуск, статистика, получатели.

public_campaigns_list

читает

Список рассылок. Архивные по умолчанию скрыты.

ПараметрТипОбяз.Значения
pageint—с 1
limitint—1–100
namestring—поиск по подстроке названия
statusstring[]—draft · built · scheduled · in_progress · paused · completed · banned · on_hold
archivedbool—true — только архив
withStatsbool—добавить статистику к каждой

public_campaigns_get_by_id

читает

Одна рассылка. Для составных отдаёт структуру: abTest с вариантами и победителем, followUp, parent у части, totalStats по всей семье.

ПараметрТипОбяз.Значения
campaignIdintда—
withStatsbool——

public_campaigns_create

меняет данные

Создаёт черновик. Все поля необязательны при создании, обязательные проверяются при запуске. abTest превращает рассылку в сплит-тест по темам (2–10 вариантов).

ПараметрТипОбяз.Значения
namestring—генерируется, если не задать
subjectstring——
previewTitlestring—прехедер
senderIdnumber——
senderNamestring——
templateIdnumber——
listIdsnumber[]——
segmentIdnumber——
attachmentsnumber[]—до 20 файлов
abTestobject—variants, percent 1–99, type=subject

public_campaigns_update

меняет данные

Правит черновик. Только в статусе DRAFT, меняются лишь переданные поля. abTest.variants заменяет весь набор вариантов целиком.

ПараметрТипОбяз.Значения
campaignIdintда—
namestring——
subjectstring——
previewTitlestring——
senderIdnumber——
senderNamestring——
templateIdnumber——
listIdsnumber[]——
segmentIdnumber——
attachmentsnumber[]——
abTestobject——

public_campaigns_delete

отправляет письма / необратимо

Удаляет черновик вместе с его шаблоном. Только DRAFT. Через API не отменяется.

ПараметрТипОбяз.Значения
campaignIdintда—

public_campaigns_schedule

отправляет письма / необратимо

Запускает черновик: модерация, затем отправка — сразу или в указанное время. Требует шаблон, отправителя, тему и хотя бы один список; у A/B ещё и abTest.percent. followUp и chunkSettings взаимоисключающие и недоступны для A/B.

ПараметрТипОбяз.Значения
campaignIdintда—
scheduledStartDatestring—ISO 8601, не в прошлом
followUpobject—subject + offsetHours (минимум 24) — досыл неоткрывшим
chunkSettingsobject—initialChunkSize + increaseChunkSizePercent — отправка порциями по дням

public_campaigns_archive

меняет данные

В архив. Только COMPLETED или BANNED; у A/B и follow-up архивируется вся семья.

ПараметрТипОбяз.Значения
campaignIdintда—

public_campaigns_unarchive

меняет данные

Из архива. Тоже всей семьёй.

ПараметрТипОбяз.Значения
campaignIdintда—

public_campaigns_recipients

читает

Поимённый список получателей с фильтром по статусу. Единственный способ выгрузить адреса. Точного числа страниц нет — только hasMore.

ПараметрТипОбяз.Значения
campaignIdintда—
pageint——
limitint—1–100
statusstring[]—delivered · opened · clicked · unsubscribed · complaint · error · soft_bounced · hard_bounced · error_infrastructure · not_delivered

public_campaigns_get_activity

читает

Открытия и клики по временным отрезкам. Агрегат, адресов не отдаёт.

ПараметрТипОбяз.Значения
campaignIdintда—

public_campaigns_get_link_clicks

читает

Клики в разрезе ссылок письма.

ПараметрТипОбяз.Значения
campaignIdintда—

public_campaigns_get_stats_by_domains

читает

Статистика в разрезе почтовых систем получателей.

ПараметрТипОбяз.Значения
campaignIdintда—

public_campaigns_ab_test_preview

читает

Считает, как разделится база при заданном проценте теста: сколько контактов на вариант и сколько получит победителя. Ничего не меняет.

ПараметрТипОбяз.Значения
campaignIdintда—
percentnumber—1–99, по умолчанию 10

public_campaigns_chunks_preview

читает

Считает разбивку на дневные порции: сколько порций, по сколько контактов и в какие даты. Ничего не меняет.

ПараметрТипОбяз.Значения
campaignIdintда—
initialChunkSizenumberдаминимум 1
increaseChunkSizePercentnumber—без него — равные порции
scheduledStartDatestring—ISO 8601

Папки рассылок

Группировка кампаний. Рассылка может лежать только в одной папке.

public_folders_list

читает

Список папок.

ПараметрТипОбяз.Значения
pageint——
limitint—1–100
qstring—поиск по названию

public_folders_get_by_id

читает

Одна папка.

ПараметрТипОбяз.Значения
folderIdintда—

public_folders_create

меняет данные

Создаёт папку.

ПараметрТипОбяз.Значения
namestringдадо 200 символов

public_folders_update

меняет данные

Переименовывает папку.

ПараметрТипОбяз.Значения
folderIdintда—
namestring——

public_folders_delete

меняет данные

Мягко удаляет папку. Рассылки не удаляются, только отвязываются.

ПараметрТипОбяз.Значения
folderIdintда—

public_folders_campaigns_add

меняет данные

Кладёт рассылки в папку. Рассылка может быть только в одной папке, поэтому добавление её переносит. Несуществующие id молча игнорируются; в affectedCampaigns — сколько реально добавлено.

ПараметрТипОбяз.Значения
folderIdintда—
campaignIdsnumber[]да—

public_folders_campaigns_remove

меняет данные

Убирает рассылки из папки, не удаляя их.

ПараметрТипОбяз.Значения
folderIdintда—
campaignIdsnumber[]да—

Контакты

Контакт живёт в аккаунте, а не в списке: он может состоять сразу в нескольких списках.

public_contacts_list

читает

Поиск контактов по всему аккаунту.

ПараметрТипОбяз.Значения
pageint——
limitint—1–100
emailstring—точное совпадение
listIdnumber——
statusstring[]—new · active · unsubscribed · unsubscribed_by_us · soft_bounced · hard_bounced · error · complaint
sortByenum—id · email · createdAt · updatedAt · lastActivityAt
sortDirenum—asc · desc

public_contacts_get_by_id

читает

Один контакт.

ПараметрТипОбяз.Значения
contactIdintда—

public_contacts_update

меняет данные

Меняет имя и телефон контакта.

ПараметрТипОбяз.Значения
contactIdintда—
namestring——
phonestring——

public_contacts_delete

отправляет письма / необратимо

Насовсем удаляет контакт из всех списков.

ПараметрТипОбяз.Значения
contactIdintда—

public_contacts_bulk_delete

отправляет письма / необратимо

Массовое удаление, 1–1000 id за раз. Необратимо.

ПараметрТипОбяз.Значения
contactIdsnumber[]да1–1000

public_contacts_statistics

читает

Агрегат по контактам; с listId — в пределах списка.

ПараметрТипОбяз.Значения
listIdnumber——

public_contacts_unsubscribe

меняет данные

Отписывает контакт глобально.

ПараметрТипОбяз.Значения
contactIdintда—

public_contacts_subscribe_back

меняет данные

Возвращает подписку ранее отписавшемуся.

ПараметрТипОбяз.Значения
contactIdintда—

public_contacts_remove_from_all_lists

меняет данные

Выкидывает контакты из всех списков, сами контакты остаются. 1–1000 id.

ПараметрТипОбяз.Значения
contactIdsnumber[]да1–1000

public_contacts_api_sending_history

читает

История транзакционных писем этому контакту.

ПараметрТипОбяз.Значения
contactIdintда—
pageint——
limitint—1–100

public_contacts_distribution_sending_history

читает

История массовых рассылок этому контакту.

ПараметрТипОбяз.Значения
contactIdintда—
pageint——
limitint—1–100

Списки контактов

Список — контейнер адресов. Переменные определяются на уровне списка.

public_lists_list

читает

Все списки аккаунта с числом контактов.

ПараметрТипОбяз.Значения
pageint——
limitint—1–100
qstring—поиск по названию
statusenum—enabled · disabled
sortByenum—id · name · createdAt · updatedAt
sortDirenum—asc · desc

public_lists_get_by_id

читает

Один список.

ПараметрТипОбяз.Значения
listIdintда—

public_lists_create

меняет данные

Создаёт список.

ПараметрТипОбяз.Значения
namestringда—

public_lists_update

меняет данные

Переименовывает список или включает/выключает его.

ПараметрТипОбяз.Значения
listIdintда—
namestring——
statusenum—enabled · disabled

public_lists_delete

меняет данные

Мягкое удаление списка.

ПараметрТипОбяз.Значения
listIdintда—

public_lists_statistics

читает

Статистика контактов внутри списка.

ПараметрТипОбяз.Значения
listIdintда—

public_lists_contacts_list

читает

Контакты списка вместе со значениями переменных.

ПараметрТипОбяз.Значения
listIdintда—
pageint——
limitint—1–100
emailstring—точное
statusstring[]—те же 8 статусов контакта
sortByenum——
sortDirenum——

public_lists_contacts_create

меняет данные

Создаёт контакт или переиспользует существующий: поиск по email внутри аккаунта. Если такой email уже есть — имя и телефон из запроса игнорируются, переменные применяются в обоих случаях. Дубль никогда не ошибка, различить по флагу created.

ПараметрТипОбяз.Значения
listIdintда—
emailstringда—
namestring——
phonestring——
variablesobject—ключ → значение

public_lists_contacts_add

меняет данные

Добавляет в список уже существующие контакты. Недоступные id молча игнорируются; в affectedContacts — сколько реально добавлено (уже состоявшие не считаются).

ПараметрТипОбяз.Значения
listIdintда—
contactIdsnumber[]да—

public_lists_contacts_import

меняет данные

Импорт до 1000 контактов за вызов. Незнакомые ключи переменных нужно объявить в variables, иначе они не создадутся.

ПараметрТипОбяз.Значения
listIdintда—
rowsobject[]дадо 1000: email, name, phone, variables
updateExistingbool—по умолчанию false
variablesobject[]—key + name + type (string · phone)

public_lists_contacts_update

меняет данные

Правит контакт в контексте списка, включая переменные. null сбрасывает значение.

ПараметрТипОбяз.Значения
listIdintда—
contactIdintда—
namestring——
phonestring——
variablesobject——

public_lists_contacts_move

меняет данные

Атомарно переносит контакты в другой список. Переносятся только те, кто реально состоит в исходном; уже находящиеся в целевом считаются перенесёнными.

ПараметрТипОбяз.Значения
listIdintдаоткуда
toListIdnumberдакуда, обязан отличаться
contactIdsnumber[]да—

public_lists_contacts_remove

меняет данные

Убирает контакты из списка, не удаляя их из аккаунта.

ПараметрТипОбяз.Значения
listIdintда—
contactIdsnumber[]да—

Сегменты

Динамическая выборка по условиям. Размер сегмента через API не читается.

public_segments_list

читает

Сегменты с их условиями.

ПараметрТипОбяз.Значения
pageint——
limitint—1–100
namestring—подстрока, без учёта регистра

public_segments_get_by_id

читает

Сегмент со всеми условиями.

ПараметрТипОбяз.Значения
segmentIdintда—

public_segments_create

меняет данные

Создаёт сегмент с произвольным набором условий.

ПараметрТипОбяз.Значения
namestringда—
applyConditionsTypeenum—and (по умолчанию) · or
conditionsobject[]—field + operator + value; для field=variable нужен variableId

public_segments_update

меняет данные

Правит сегмент. Если передать conditions — весь набор заменяется целиком; если не передать — условия не трогаются.

ПараметрТипОбяз.Значения
segmentIdintда—
namestring——
applyConditionsTypeenum——
conditionsobject[]——

public_segments_list_filters

читает

Какие поля доступны для условий, включая переменные контактов, и какие операторы к каждому применимы.

Без параметров.

Переменные

Пользовательские поля контакта. Определяются в пределах списка.

public_variables_list

читает

Определения переменных списка.

ПараметрТипОбяз.Значения
listIdintда—

public_variables_create

меняет данные

Создаёт переменную.

ПараметрТипОбяз.Значения
listIdintда—
keystringдастрочные буквы, цифры, подчёркивания; начинается с буквы; до 50
namestringдадо 50
typeenum—string (по умолчанию) · phone
defaultValuestring——

public_variables_update

меняет данные

Меняет отображаемое имя и значение по умолчанию.

ПараметрТипОбяз.Значения
listIdintда—
variableIdintда—
namestring——
defaultValuestring—null очищает

public_variables_delete

отправляет письма / необратимо

Удаляет переменную вместе со всеми её значениями.

ПараметрТипОбяз.Значения
listIdintда—
variableIdintда—

Транзакционные письма и ключи

Отправка по SMTP/API-ключу. Ключ привязан к подтверждённому домену.

public_external_mail_keys_list

читает

Ключи отправки аккаунта.

ПараметрТипОбяз.Значения
pageint——
limitint—1–100

public_external_mail_keys_get_by_id

читает

Один ключ.

ПараметрТипОбяз.Значения
keyIdintда—

public_external_mail_keys_create

меняет данные

Создаёт ключ для подтверждённого домена. Создаётся в статусе DISABLED и включается после модерации платформой.

ПараметрТипОбяз.Значения
namestringда—
domainIdnumberда—

public_external_mail_keys_update

меняет данные

Переименовывает ключ.

ПараметрТипОбяз.Значения
keyIdintда—
namestring—до 245

public_external_mail_keys_delete

отправляет письма / необратимо

Удаляет ключ. Отправка по нему прекращается немедленно, отменить через API нельзя.

ПараметрТипОбяз.Значения
keyIdintда—

public_external_mail_key_stats

читает

Агрегат по ключу за период (по предрассчитанным дневным данным). Без дат — последние 30 суток.

ПараметрТипОбяз.Значения
keyIdintда—
dateFromstring—YYYY-MM-DD
dateTostring—YYYY-MM-DD

public_external_mails_list

читает

Все транзакционные письма аккаунта, от свежих к старым. Точного числа страниц нет — только hasMore. Фильтра по теме нет.

ПараметрТипОбяз.Значения
pageint——
limitint—1–100
keyIdnumber——
statusstring[]—delivered · opened · clicked · unsubscribed · complaint · error · soft_bounced · hard_bounced · sending · pending
dateFromstring—YYYY-MM-DD
dateTostring—YYYY-MM-DD
toEmailstring—частичное совпадение
fromEmailstring—точное

public_external_mail_send

отправляет письма / необратимо

Отправляет письмо по ключу. Нужен html и/или text — хотя бы одно. Ключ выбирать по домену адреса в mail.from.

ПараметрТипОбяз.Значения
key_idnumberда—
mail.toobjectдаemail + name
mail.fromobjectдаemail + name
mail.subjectstringда—
mail.htmlstring—html или text обязателен
mail.textstring——
mail.previewTitlestring——
mail.ccstring——
mail.bccstring——
mail.headersobject——

public_external_mail_send_by_template

отправляет письма / необратимо

То же, но письмо собирается из сохранённого шаблона: id в mail.idTemplateMailUser, подстановки в mail.params.

ПараметрТипОбяз.Значения
key_idnumberда—
mail.toobjectда—
mail.fromobjectда—
mail.subjectstringда—
mail.idTemplateMailUsernumberда—
mail.paramsobject—подстановки
mail.previewTitlestring——
mail.ccstring——
mail.bccstring——
mail.headersobject——

Цепочки

Автоматические сценарии. Через MCP доступен только запуск.

public_chains_trigger

отправляет письма / необратимо

Запускает активную цепочку для контакта по её webhook-токену. Поля data кроме email и name сохраняются как свойства контакта.

ПараметрТипОбяз.Значения
webhookTokenstringда—
emailstringда—
namestring——

Домены

Домены отправки и их DNS-записи.

public_domains_list

читает

Домены аккаунта вместе с DNS-записями.

ПараметрТипОбяз.Значения
pageint——
limitint—1–100

public_domains_get_by_id

читает

Один домен с записями.

ПараметрТипОбяз.Значения
domainIdintда—

public_domains_create

меняет данные

Добавляет домен и генерирует записи DKIM, SPF, DMARC, которые нужно прописать в DNS-зоне. После этого запустить проверку.

ПараметрТипОбяз.Значения
namestringданапример example.com

public_domains_verify

меняет данные

Проверяет DNS: резолвит и валидирует DKIM, SPF, DMARC, обновляет статус. Может вернуть предупреждения (например, несколько SPF-записей) и предложить объединённую SPF.

ПараметрТипОбяз.Значения
domainIdintда—

public_domains_delete

меняет данные

Удаляет неподтверждённый домен. Подтверждённый удалить через API нельзя — на нём висят ключи и отправители.

ПараметрТипОбяз.Значения
domainIdintда—

Отправители

Адреса в поле From. Подтверждаются письмом.

public_senders_list

читает

Отправители аккаунта.

ПараметрТипОбяз.Значения
pageint——
limitint—1–100
verifiedenum—enabled · disabled

public_senders_get_by_id

читает

Один отправитель.

ПараметрТипОбяз.Значения
senderIdintда—

public_senders_create

отправляет письма / необратимо

Добавляет адрес отправителя. На адрес всегда уходит письмо с подтверждением; отправитель становится подтверждённым только после клика по ссылке. Адреса на своём подтверждённом домене доставляются лучше.

ПараметрТипОбяз.Значения
emailstringда—

public_senders_resend_confirmation

отправляет письма / необратимо

Повторно шлёт письмо с подтверждением на неподтверждённый адрес.

ПараметрТипОбяз.Значения
senderIdintда—

Шаблоны

HTML-шаблоны писем. Шаблоны из конструктора править нельзя.

public_templates_list_v2

читает

Шаблоны аккаунта.

ПараметрТипОбяз.Значения
pageint——
limitint—1–100
namestring—подстрока

public_templates_list

читает · устарело

То же, устаревшая версия. Использовать v2.

ПараметрТипОбяз.Значения
pageint——
limitint—1–100
namestring——

public_templates_get_by_id

читает

Шаблон вместе с HTML.

ПараметрТипОбяз.Значения
templateIdintда—

public_templates_create

меняет данные

Создаёт HTML-шаблон (type=html).

ПараметрТипОбяз.Значения
namestringда—
htmlstringда—
textstring—текстовая версия

public_templates_update

меняет данные

Правит HTML-шаблон. Шаблоны конструктора (type=builder) править запрещено.

ПараметрТипОбяз.Значения
templateIdintда—
namestring——
htmlstring——
textstring——

Вебхуки

Уведомления о событиях. Удаления через MCP нет — только отключение статусом.

public_webhooks_list

читает

Вебхуки аккаунта.

ПараметрТипОбяз.Значения
pageint——
limitint—1–100

public_webhooks_get_by_id

читает

Один вебхук.

ПараметрТипОбяз.Значения
webhookIdintда—

public_webhooks_create

меняет данные

Создаёт вебхук. Нужен хотя бы один триггер.

ПараметрТипОбяз.Значения
namestringда—
urlstringдадо 2048
triggersstring[]да22 события, см. ниже
statusenum—enabled (по умолчанию) · disabled

public_webhooks_update

меняет данные

Частично правит вебхук. Переданный triggers заменяет список событий целиком.

ПараметрТипОбяз.Значения
webhookIdintда—
namestring——
urlstring——
triggersstring[]——
statusenum——

Дата публикации Дата публикации: 1 сентября 2026 Обновлено: 22 сентября 2026