Mailchimp

Аудитории, кампании, сегменты и автоматизации Mailchimp в процессах Pailot

Mailchimp — email-маркетинг: аудитории (списки), кампании, автоматизации, сегменты, теги и посадочные страницы.

С Mailchimp в Pailot вы можете:

Создавать и менять аудитории и участников (добавление, обновление, архив)
Создавать, отправлять, планировать и копировать кампании; смотреть отчёты
Запускать и ставить на паузу автоматизации
Шаблоны, сегменты, теги, merge fields (поля слияния — подстановки в письме) и группы интересов
Посадочные страницы и пакетные операции

Нужен ключ API (Application Programming Interface — программный интерфейс) Mailchimp.

Блок ставят на холст как отдельный шаг или прикрепляют к агенту. Ключ — в переменных окружения рабочего пространства.

Инструменты

`mailchimp_get_audiences`

Список аудиторий (списков) в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`count`	string	Нет	Число результатов (по умолчанию 10, максимум 1000)
`offset`	string	Нет	Сколько результатов пропустить

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить аудитории
`output`	object	Данные аудиторий
↳ `lists`	json	Массив audience/list objects
↳ `total_items`	number	Всего lists
↳ `total_returned`	number	Число списков в этом ответе

`mailchimp_get_audience`

Карточка аудитории (списка) в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить аудитория
`output`	object	Данные аудитории
↳ `list`	json	Объект аудитории
↳ `list_id`	string	ID аудитории

`mailchimp_create_audience`

Создать аудиторию (список) в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`audienceName`	string	Да	Название списка
`contact`	string	Да	JSON-объект контактных данных
`permissionReminder`	string	Да	Текст напоминания о разрешении
`campaignDefaults`	string	Да	JSON-объект настроек кампании по умолчанию
`emailTypeOption`	string	Да	Несколько форматов писем

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные созданной аудитории
↳ `list`	json	Созданная аудитория
↳ `list_id`	string	ID созданной аудитории
↳ `success`	boolean	Успешность операции

`mailchimp_update_audience`

Обновить аудиторию (список) в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`audienceName`	string	Нет	Название списка
`permissionReminder`	string	Нет	Текст напоминания о разрешении
`campaignDefaults`	string	Нет	JSON-объект настроек кампании по умолчанию
`emailTypeOption`	string	Нет	Несколько форматов писем

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные обновлённой аудитории
↳ `list`	object	Обновлённая аудитория
↳ `list_id`	string	ID списка
↳ `success`	boolean	Успешность операции

`mailchimp_delete_audience`

Удалить аудиторию (список) в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID list для удаления

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли удалить аудитория

`mailchimp_get_members`

Список участников аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`status`	string	Нет	Фильтр по статусу (subscribed, unsubscribed, cleaned, pending)
`count`	string	Нет	Число результатов (по умолчанию 10, максимум 1000)
`offset`	string	Нет	Сколько результатов пропустить

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить участники
`output`	object	Данные участников
↳ `members`	json	Массив member objects
↳ `total_items`	number	Всего members
↳ `total_returned`	number	Число участников в этом ответе

`mailchimp_get_member`

Карточка участника аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`subscriberEmail`	string	Да	Email участника или MD5-хеш

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить участник
`output`	object	Данные участника
↳ `member`	json	Объект участника
↳ `subscriber_hash`	string	MD5-хеш email участника

`mailchimp_add_member`

Добавить участника в аудиторию Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`emailAddress`	string	Да	Email участника
`status`	string	Да	Статус подписчика
`mergeFields`	string	Нет	JSON-объект полей слияния
`interests`	string	Нет	JSON-объект интересов

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные добавленного участника
↳ `member`	json	Добавленный участник
↳ `subscriber_hash`	string	ID хеша подписчика
↳ `success`	boolean	Успешность операции

`mailchimp_add_or_update_member`

Добавить или обновить участника аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`subscriberEmail`	string	Да	Email участника или MD5-хеш
`emailAddress`	string	Да	Email участника
`statusIfNew`	string	Да	Статус подписчика, если участник новый
`mergeFields`	string	Нет	JSON-объект полей слияния
`interests`	string	Нет	JSON-объект интересов

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные участника
↳ `member`	json	Объект участника
↳ `subscriber_hash`	string	ID хеша подписчика
↳ `success`	boolean	Успешность операции

`mailchimp_update_member`

Обновить участника аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`subscriberEmail`	string	Да	Email участника или MD5-хеш
`emailAddress`	string	Нет	Email участника
`status`	string	Нет	Статус подписчика
`mergeFields`	string	Нет	JSON-объект полей слияния
`interests`	string	Нет	JSON-объект интересов

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные обновлённого участника
↳ `member`	object	Обновлённый участник
↳ `subscriber_hash`	string	Хеш подписчика
↳ `success`	boolean	Успешность операции

`mailchimp_delete_member`

Удалить участника аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`subscriberEmail`	string	Да	Email участника или MD5-хеш

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли удалить участник

`mailchimp_archive_member`

Навсегда архивировать (удалить) участника аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`subscriberEmail`	string	Да	Email участника или MD5-хеш

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Подтверждение архивации
↳ `success`	boolean	Успешность операции

`mailchimp_unarchive_member`

Вернуть заархивированного участника в аудиторию Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`subscriberEmail`	string	Да	Email участника или MD5-хеш
`emailAddress`	string	Да	Email участника
`status`	string	Да	Статус подписчика

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные разархивированного участника
↳ `member`	object	Разархивированный участник
↳ `subscriber_hash`	string	Хеш подписчика
↳ `success`	boolean	Успешность операции

`mailchimp_get_campaigns`

Список кампаний в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`campaignType`	string	Нет	Фильтр по типу кампании (regular, plaintext, absplit, rss, variate)
`status`	string	Нет	Фильтр по статусу (save, paused, schedule, sending, sent)
`count`	string	Нет	Число результатов (по умолчанию 10, максимум 1000)
`offset`	string	Нет	Сколько результатов пропустить

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить кампании
`output`	object	Данные кампаний
↳ `campaigns`	json	Массив campaign objects
↳ `total_items`	number	Всего campaigns
↳ `total_returned`	number	Число кампаний в этом ответе

`mailchimp_get_campaign`

Карточка кампании в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`campaignId`	string	Да	ID кампании

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить кампания
`output`	object	Данные кампании
↳ `campaign`	json	Объект кампании
↳ `campaign_id`	string	ID кампании

`mailchimp_create_campaign`

Создать кампанию в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`campaignType`	string	Да	Тип кампании
`campaignSettings`	string	Да	JSON-объект настроек кампании
`recipients`	string	Нет	JSON-объект получателей

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные созданной кампании
↳ `campaign`	json	Созданная кампания
↳ `campaign_id`	string	ID созданной кампании
↳ `success`	boolean	Успешность операции

`mailchimp_update_campaign`

Обновить кампанию в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`campaignId`	string	Да	ID кампании
`campaignSettings`	string	Нет	JSON-объект настроек кампании
`recipients`	string	Нет	JSON-объект получателей

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные обновлённой кампании
↳ `campaign`	object	Обновлённая кампания
↳ `campaign_id`	string	ID кампании
↳ `success`	boolean	Успешность операции

`mailchimp_delete_campaign`

Удалить кампанию в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`campaignId`	string	Да	ID кампании для удаления

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли удалить кампания

`mailchimp_send_campaign`

Отправить кампанию Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`campaignId`	string	Да	ID кампании для отправки

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Подтверждение отправки
↳ `success`	boolean	Успешность операции

`mailchimp_schedule_campaign`

Запланировать кампанию Mailchimp на заданное время

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`campaignId`	string	Да	ID кампании для планирования
`scheduleTime`	string	Да	Дата и время в формате ISO 8601

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли запланировать кампания

`mailchimp_unschedule_campaign`

Снять запланированную кампанию Mailchimp с расписания

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`campaignId`	string	Да	ID кампании для снятия с расписания

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Подтверждение снятия с расписания
↳ `success`	boolean	Успешность операции

`mailchimp_replicate_campaign`

Скопировать кампанию Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`campaignId`	string	Да	ID кампании для копирования

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные скопированной кампании
↳ `campaign`	object	Скопированная кампания
↳ `campaign_id`	string	ID кампании
↳ `success`	boolean	Успешность операции

`mailchimp_get_campaign_content`

Получить HTML и обычный текст кампании Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`campaignId`	string	Да	ID кампании

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить содержимое кампании
`output`	object	Данные содержимого кампании
↳ `content`	json	Содержимое кампании

`mailchimp_set_campaign_content`

Задать содержимое кампании Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`campaignId`	string	Да	ID кампании
`html`	string	Нет	HTML кампании
`plainText`	string	Нет	Обычный текст кампании
`templateId`	string	Нет	ID используемого шаблона

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные содержимого кампании
↳ `content`	object	Содержимое кампании
↳ `success`	boolean	Успешность операции

`mailchimp_get_automations`

Список автоматизаций в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`count`	string	Нет	Число результатов (по умолчанию 10, максимум 1000)
`offset`	string	Нет	Сколько результатов пропустить

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить автоматизации
`output`	object	Данные автоматизаций
↳ `automations`	json	Массив automation objects
↳ `total_items`	number	Всего automations
↳ `total_returned`	number	Число автоматизаций в этом ответе

`mailchimp_get_automation`

Карточка автоматизации в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`workflowId`	string	Да	ID автоматизация

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить автоматизация
`output`	object	Данные автоматизации
↳ `automation`	json	Объект автоматизации
↳ `workflow_id`	string	ID автоматизации

`mailchimp_start_automation`

Запустить все письма автоматизации Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`workflowId`	string	Да	ID автоматизация

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Подтверждение запуска
↳ `success`	boolean	Успешность операции

`mailchimp_pause_automation`

Поставить на паузу письма автоматизации Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`workflowId`	string	Да	ID автоматизация

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Подтверждение паузы
↳ `success`	boolean	Успешность операции

`mailchimp_add_subscriber_to_automation`

Вручную добавить подписчика в очередь письма автоматизации

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`workflowId`	string	Да	ID автоматизация
`workflowEmailId`	string	Да	ID workflow
`emailAddress`	string	Да	Email подписчика

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные очереди подписчика
↳ `subscriber`	json	Объект подписчика
↳ `success`	boolean	Успешность операции

`mailchimp_get_templates`

Список шаблонов в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`count`	string	Нет	Число результатов (по умолчанию 10, максимум 1000)
`offset`	string	Нет	Сколько результатов пропустить

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить шаблоны
`output`	object	Данные шаблонов
↳ `templates`	json	Массив template objects
↳ `total_items`	number	Всего templates
↳ `total_returned`	number	Число шаблонов в этом ответе

`mailchimp_get_template`

Карточка шаблона в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`templateId`	string	Да	ID шаблон

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить шаблон
`output`	object	Данные шаблона
↳ `template`	json	Объект шаблона
↳ `template_id`	string	ID шаблона

`mailchimp_create_template`

Создать шаблон в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`templateName`	string	Да	Название шаблона
`templateHtml`	string	Да	HTML шаблона

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные созданного шаблона
↳ `template`	json	Созданный шаблон
↳ `template_id`	string	ID созданного шаблона
↳ `success`	boolean	Успешность операции

`mailchimp_update_template`

Обновить шаблон в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`templateId`	string	Да	ID шаблон
`templateName`	string	Нет	Название шаблона
`templateHtml`	string	Нет	HTML шаблона

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные обновлённого шаблона
↳ `template`	object	Обновлённый шаблон
↳ `template_id`	string	ID шаблона
↳ `success`	boolean	Успешность операции

`mailchimp_delete_template`

Удалить шаблон в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`templateId`	string	Да	ID шаблон для удаления

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли удалить шаблон

`mailchimp_get_campaign_reports`

Список отчётов кампаний в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`count`	string	Нет	Число результатов (по умолчанию 10, максимум 1000)
`offset`	string	Нет	Сколько результатов пропустить

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить отчёты кампаний
`output`	object	Данные отчётов кампаний
↳ `reports`	json	Массив campaign report objects
↳ `total_items`	number	Всего reports
↳ `total_returned`	number	Число отчётов в этом ответе

`mailchimp_get_campaign_report`

Отчёт конкретной кампании Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`campaignId`	string	Да	ID кампании

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить отчёт кампании
`output`	object	Данные отчёта кампании
↳ `report`	json	Отчёт кампании
↳ `campaign_id`	string	ID кампании

`mailchimp_get_segments`

Список сегментов аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`count`	string	Нет	Число результатов (по умолчанию 10, максимум 1000)
`offset`	string	Нет	Сколько результатов пропустить

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить сегменты
`output`	object	Данные сегментов
↳ `segments`	json	Массив segment objects
↳ `total_items`	number	Всего segments
↳ `total_returned`	number	Число сегментов в этом ответе

`mailchimp_get_segment`

Карточка сегмента аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`segmentId`	string	Да	ID сегмент

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить сегмент
`output`	object	Данные сегмента
↳ `segment`	json	Объект сегмента
↳ `segment_id`	string	ID сегмента

`mailchimp_create_segment`

Создать сегмент в аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`segmentName`	string	Да	Название сегмента
`segmentOptions`	string	Нет	JSON-объект параметров сегмента

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные созданного сегмента
↳ `segment`	json	Созданный сегмент
↳ `segment_id`	string	ID созданного сегмента
↳ `success`	boolean	Успешность операции

`mailchimp_update_segment`

Обновить сегмент в аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`segmentId`	string	Да	ID сегмент
`segmentName`	string	Нет	Название сегмента
`segmentOptions`	string	Нет	JSON-объект параметров сегмента

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные обновлённого сегмента
↳ `segment`	object	Обновлённый сегмент
↳ `segment_id`	string	ID сегмента
↳ `success`	boolean	Успешность операции

`mailchimp_delete_segment`

Удалить сегмент аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`segmentId`	string	Да	ID сегмент для удаления

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли удалить сегмент

`mailchimp_get_segment_members`

Участники сегмента аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`segmentId`	string	Да	ID сегмент
`count`	string	Нет	Число результатов (по умолчанию 10, максимум 1000)
`offset`	string	Нет	Сколько результатов пропустить

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить участники сегмента
`output`	object	Данные участников сегмента
↳ `members`	json	Массив member objects
↳ `total_items`	number	Всего members
↳ `total_returned`	number	Число участников в этом ответе

`mailchimp_add_segment_member`

Добавить участника в сегмент аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`segmentId`	string	Да	ID сегмент
`emailAddress`	string	Да	Email участника

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные добавленного участника
↳ `member`	json	Добавленный участник
↳ `success`	boolean	Успешность операции

`mailchimp_remove_segment_member`

Убрать участника из сегмента аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`segmentId`	string	Да	ID сегмент
`subscriberEmail`	string	Да	Email участника или MD5-хеш

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Подтверждение удаления
↳ `success`	boolean	Успешность операции

`mailchimp_get_member_tags`

Теги участника аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`subscriberEmail`	string	Да	Email участника или MD5-хеш

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить теги участника
`output`	object	Данные тегов участника
↳ `tags`	json	Объекты тегов
↳ `total_items`	number	Всего тегов
↳ `total_returned`	number	Число тегов в этом ответе

`mailchimp_add_member_tags`

Добавить теги участнику аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`subscriberEmail`	string	Да	Email участника или MD5-хеш
`tags`	string	Да	JSON-массив тегов

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Подтверждение добавления тега
↳ `success`	boolean	Успешность операции

`mailchimp_remove_member_tags`

Снять теги с участника аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`subscriberEmail`	string	Да	Email участника или MD5-хеш
`tags`	string	Да	JSON-массив тегов со статусом inactive

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Подтверждение снятия тега
↳ `success`	boolean	Успешность операции

`mailchimp_get_merge_fields`

Список полей слияния аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`count`	string	Нет	Число результатов (по умолчанию 10, максимум 1000)
`offset`	string	Нет	Сколько результатов пропустить

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить поля слияния
`output`	object	Данные полей слияния
↳ `mergeFields`	json	Объекты полей слияния
↳ `total_items`	number	Всего merge fields
↳ `total_returned`	number	Число полей слияния в этом ответе

`mailchimp_get_merge_field`

Карточка поля слияния аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`mergeId`	string	Да	ID поле слияния

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить поле слияния
`output`	object	Данные поля слияния
↳ `mergeField`	json	Объект поля слияния
↳ `merge_id`	string	ID поля слияния

`mailchimp_create_merge_field`

Создать поле слияния в аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`mergeName`	string	Да	Название поля слияния
`mergeType`	string	Да	Тип поля слияния (text, number, address, phone, date, url, imageurl, radio, dropdown, birthday, zip)

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные созданного поля слияния
↳ `mergeField`	json	Созданное поле слияния
↳ `merge_id`	string	ID созданного поля слияния
↳ `success`	boolean	Успешность операции

`mailchimp_update_merge_field`

Обновить поле слияния в аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`mergeId`	string	Да	ID поле слияния
`mergeName`	string	Нет	Название поля слияния

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные обновлённого поля слияния
↳ `mergeField`	object	Обновлённое поле слияния
↳ `merge_id`	string	ID поля слияния
↳ `success`	boolean	Успешность операции

`mailchimp_delete_merge_field`

Удалить поле слияния аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`mergeId`	string	Да	ID поле слияния для удаления

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли удалить поле слияния

`mailchimp_get_interest_categories`

Список категорий интересов аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`count`	string	Нет	Число результатов (по умолчанию 10, максимум 1000)
`offset`	string	Нет	Сколько результатов пропустить

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить категории интересов
`output`	object	Данные категорий интересов
↳ `categories`	json	Массив interest category objects
↳ `total_items`	number	Всего categories
↳ `total_returned`	number	Число категорий в этом ответе

`mailchimp_get_interest_category`

Карточка категории интересов аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`interestCategoryId`	string	Да	ID категория интересов

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить категория интересов
`output`	object	Данные категории интересов
↳ `category`	json	Объект категории интересов
↳ `interest_category_id`	string	ID категории интересов

`mailchimp_create_interest_category`

Создать категорию интересов в аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`interestCategoryTitle`	string	Да	Название категории интересов
`interestCategoryType`	string	Да	Тип категории интересов (checkboxes, dropdown, radio, hidden)

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные созданной категории интересов
↳ `category`	json	Созданная категория интересов
↳ `interest_category_id`	string	ID созданной категории интересов
↳ `success`	boolean	Успешность операции

`mailchimp_update_interest_category`

Обновить категорию интересов в аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`interestCategoryId`	string	Да	ID категория интересов
`interestCategoryTitle`	string	Нет	Название категории интересов

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные обновлённой категории интересов
↳ `category`	object	Обновлённая категория интересов
↳ `interest_category_id`	string	ID категории интересов
↳ `success`	boolean	Успешность операции

`mailchimp_delete_interest_category`

Удалить категорию интересов аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`interestCategoryId`	string	Да	ID категории интересов для удаления

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли удалить категория интересов

`mailchimp_get_interests`

Список интересов категории аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`interestCategoryId`	string	Да	ID категория интересов
`count`	string	Нет	Число результатов (по умолчанию 10, максимум 1000)
`offset`	string	Нет	Сколько результатов пропустить

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить интересы
`output`	object	Данные интересов
↳ `interests`	json	Массив interest objects
↳ `total_items`	number	Всего interests
↳ `total_returned`	number	Число интересов в этом ответе

`mailchimp_get_interest`

Карточка интереса в категории аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`interestCategoryId`	string	Да	ID категория интересов
`interestId`	string	Да	ID интерес

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить интерес
`output`	object	Данные интереса
↳ `interest`	json	Объект интереса
↳ `interest_id`	string	ID интереса

`mailchimp_create_interest`

Создать интерес в категории аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`interestCategoryId`	string	Да	ID категория интересов
`interestName`	string	Да	Название интереса

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные созданного интереса
↳ `interest`	json	Созданный интерес
↳ `interest_id`	string	ID созданного интереса
↳ `success`	boolean	Успешность операции

`mailchimp_update_interest`

Обновить интерес в категории аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`interestCategoryId`	string	Да	ID категория интересов
`interestId`	string	Да	ID интерес
`interestName`	string	Нет	Название интереса

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные обновлённого интереса
↳ `interest`	object	Обновлённый интерес
↳ `interest_id`	string	ID интереса
↳ `success`	boolean	Успешность операции

`mailchimp_delete_interest`

Удалить интерес из категории аудитории Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`listId`	string	Да	ID списка
`interestCategoryId`	string	Да	ID категория интересов
`interestId`	string	Да	ID интерес для удаления

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли удалить интерес

`mailchimp_get_landing_pages`

Список посадочных страниц в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`count`	string	Нет	Число результатов (по умолчанию 10, максимум 1000)
`offset`	string	Нет	Сколько результатов пропустить

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить посадочные страницы
`output`	object	Данные посадочных страниц
↳ `landingPages`	json	Объекты посадочных страниц
↳ `total_items`	number	Всего landing pages
↳ `total_returned`	number	Число посадочных страниц в этом ответе

`mailchimp_get_landing_page`

Карточка посадочной страницы в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`pageId`	string	Да	ID посадочная страница

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить посадочная страница
`output`	object	Данные посадочной страницы
↳ `landingPage`	json	Объект посадочной страницы
↳ `page_id`	string	ID посадочной страницы

`mailchimp_create_landing_page`

Создать посадочную страницу в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`landingPageType`	string	Да	Тип посадочной страницы (signup)
`landingPageTitle`	string	Нет	Название посадочной страницы

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные созданной посадочной страницы
↳ `landingPage`	json	Созданная посадочная страница
↳ `page_id`	string	ID созданной посадочной страницы
↳ `success`	boolean	Успешность операции

`mailchimp_update_landing_page`

Обновить посадочную страницу в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`pageId`	string	Да	ID посадочная страница
`landingPageTitle`	string	Нет	Название посадочной страницы

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные обновлённой посадочной страницы
↳ `landingPage`	object	Обновлённая посадочная страница
↳ `page_id`	string	ID посадочной страницы
↳ `success`	boolean	Успешность операции

`mailchimp_delete_landing_page`

Удалить посадочную страницу в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`pageId`	string	Да	ID посадочная страница для удаления

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли удалить посадочная страница

`mailchimp_publish_landing_page`

Опубликовать посадочную страницу в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`pageId`	string	Да	ID посадочная страница

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Подтверждение публикации
↳ `success`	boolean	Успешность операции

`mailchimp_unpublish_landing_page`

Снять посадочную страницу с публикации в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`pageId`	string	Да	ID посадочная страница

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Подтверждение снятия с публикации
↳ `success`	boolean	Успешность операции

`mailchimp_get_batch_operations`

Список пакетных операций в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`count`	string	Нет	Число результатов (по умолчанию 10, максимум 1000)
`offset`	string	Нет	Сколько результатов пропустить

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить пакетные операции
`output`	object	Данные пакетных операций
↳ `batches`	json	Массив batch operation objects
↳ `total_items`	number	Всего batch operations
↳ `total_returned`	number	Число пакетных операций в этом ответе

`mailchimp_get_batch_operation`

Карточка пакетной операции в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`batchId`	string	Да	ID пакетная операция

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли получить пакетная операция
`output`	object	Данные пакетной операции
↳ `batch`	json	Объект пакетной операции
↳ `batch_id`	string	ID пакетной операции

`mailchimp_create_batch_operation`

Создать пакетную операцию в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`operations`	string	Да	JSON-массив операций

Выход

Параметр	Тип	Описание
`success`	boolean	Успешность операции
`output`	object	Данные созданной пакетной операции
↳ `batch`	json	Созданная пакетная операция
↳ `batch_id`	string	ID созданной пакетной операции
↳ `success`	boolean	Успешность операции

`mailchimp_delete_batch_operation`

Удалить пакетную операцию в Mailchimp

Вход

Параметр	Тип	Обязательный	Описание
`apiKey`	string	Да	Ключ API Mailchimp с префиксом сервера
`batchId`	string	Да	ID пакетной операции для удаления

Выход

Параметр	Тип	Описание
`success`	boolean	Удалось ли удалить пакетная операция

На этой странице

На этой странице

Инструменты

mailchimp_get_audiences

mailchimp_get_audience

mailchimp_create_audience

mailchimp_update_audience

mailchimp_delete_audience

mailchimp_get_members

mailchimp_get_member

mailchimp_add_member

mailchimp_add_or_update_member

mailchimp_update_member

mailchimp_delete_member

mailchimp_archive_member

mailchimp_unarchive_member

mailchimp_get_campaigns

mailchimp_get_campaign

mailchimp_create_campaign

mailchimp_update_campaign

mailchimp_delete_campaign

mailchimp_send_campaign

mailchimp_schedule_campaign

mailchimp_unschedule_campaign

mailchimp_replicate_campaign

mailchimp_get_campaign_content

mailchimp_set_campaign_content

mailchimp_get_automations

mailchimp_get_automation

mailchimp_start_automation

mailchimp_pause_automation

mailchimp_add_subscriber_to_automation

mailchimp_get_templates

mailchimp_get_template

mailchimp_create_template

mailchimp_update_template

mailchimp_delete_template

mailchimp_get_campaign_reports

mailchimp_get_campaign_report

mailchimp_get_segments

mailchimp_get_segment

mailchimp_create_segment

mailchimp_update_segment

mailchimp_delete_segment

mailchimp_get_segment_members

mailchimp_add_segment_member

mailchimp_remove_segment_member

mailchimp_get_member_tags

mailchimp_add_member_tags

mailchimp_remove_member_tags

mailchimp_get_merge_fields

mailchimp_get_merge_field

mailchimp_create_merge_field

mailchimp_update_merge_field

mailchimp_delete_merge_field

mailchimp_get_interest_categories

mailchimp_get_interest_category

mailchimp_create_interest_category

mailchimp_update_interest_category

mailchimp_delete_interest_category

mailchimp_get_interests

mailchimp_get_interest

mailchimp_create_interest

mailchimp_update_interest

mailchimp_delete_interest

mailchimp_get_landing_pages

mailchimp_get_landing_page

mailchimp_create_landing_page

mailchimp_update_landing_page

mailchimp_delete_landing_page

mailchimp_publish_landing_page

mailchimp_unpublish_landing_page

mailchimp_get_batch_operations

mailchimp_get_batch_operation

mailchimp_create_batch_operation

mailchimp_delete_batch_operation

Получить доступ

Копилот собирает процесс. Менеджер запускает сам. Можно поставить в контур компании.

Получить доступ