damientilman/mailchimp-mcp-server

damientilman/mailchimp-mcp-server

от damientilman
MCP-сервер для Mailchimp Marketing API с 115 инструментами: управление кампаниями, A/B-тестами, отчётами, аудиториями, лендингами, e-commerce. Есть безопасные режимы read-only и dry-run. Идеально д...

Mailchimp MCP Server

CI PyPI version PyPI downloads License: MIT Python 3.10+ MCP

The most complete Model Context Protocol (MCP) server for the Mailchimp Marketing API: 227 tools to query and manage your Mailchimp account from any MCP-compatible client. It covers the full campaign, audience, member, segment, automation and reporting surface, complete e-commerce (read and write), landing pages, File Manager, surveys, signup forms and verified domains, plus multi-account support and runtime-security guardrails (read-only, dry-run and audit modes, with per-tool risk metadata).

Uses the Mailchimp Marketing API via requests. Not based on the official mailchimp-marketing-python client. I hit too many issues with it so I went with raw HTTP calls instead.

Mailchimp MCP server Mailchimp MCP server score

Quick start

uvx mailchimp-mcp   # no install required; just needs MAILCHIMP_API_KEY

Add it to your MCP client (Claude Desktop, Cursor, Cline, …):

{
  "mcpServers": {
    "mailchimp": {
      "command": "uvx",
      "args": ["mailchimp-mcp"],
      "env": {
        "MAILCHIMP_API_KEY": "your-key-us8",
        "MAILCHIMP_READ_ONLY": "true"
      }
    }
  }
}
add_automation_queue_subscriber

Добавляет подписчика в очередь классического письма автоматизации. Вручную добавляет подписчика в очередь отправки для конкретного письма автоматизации. Подписчик получит письмо в рамках рабочего процесса после обработки. Аргументы: workflow_id: Уникальный идентификатор классического рабочего процесса автоматизации. workflow_email_id: Уникальный идентификатор письма автоматизации, в очередь которого нужно добавить. email_address: Адрес электронной почты подписчика для добавления в очередь. Возвращает: JSON, описывающий добавленного в очередь подписчика.

Добавляет подписчика в очередь классического письма автоматизации. Вручную добавляет подписчика в очередь отправки для конкретного письма автоматизации. Подписчик получит письмо в рамках рабочего процесса после обработки. Аргументы: workflow_id: Уникальный идентификатор классического рабочего процесса автоматизации. workflow_email_id: Уникальный идентификатор письма автоматизации, в очередь которого нужно добавить. email_address: Адрес электронной почты подписчика для добавления в очередь. Возвращает: JSON, описывающий добавленного в очередь подписчика.

Параметры

  • workflow_idstringобязательный
  • workflow_email_idstringобязательный
  • email_addressstringобязательный
  • accountany
add_member

Добавляет нового участника в аудиторию с опциональным именем и тегами. Создаёт новый контакт. Возвращает ошибку "Member Exists", если уже существует. Выберите подходящий инструмент для участника: add_member для новых контактов, update_member для изменения профиля/статуса существующих, tag_member для управления тегами существующих, batch_subscribe для массового добавления/обновления (до 500), unsubscribe_member для отписки, delete_member для постоянного удаления в соответствии с GDPR. Побочный эффект: status='pending' запускает письмо с двойным подтверждением подписки. Аргументы: list_id: ID аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. email_address: Email нового участника. Не должен уже существовать в аудитории. status: 'subscribed' (по умолчанию), 'pending' (запускает письмо с подтверждением), 'unsubscribed', 'cleaned'. first_name: Имя (поле слияния FNAME). last_name: Фамилия (поле слияния LNAME). tags: Имена тегов через запятую (например 'VIP,Newsletter'). Создаются автоматически, если новые. Возвращает: JSON с id (MD5-хэш email), email_address, status, full_name.

Добавляет нового участника в аудиторию с опциональным именем и тегами. Создаёт новый контакт. Возвращает ошибку "Member Exists", если уже существует. Выберите подходящий инструмент для участника: add_member для новых контактов, update_member для изменения профиля/статуса существующих, tag_member для управления тегами существующих, batch_subscribe для массового добавления/обновления (до 500), unsubscribe_member для отписки, delete_member для постоянного удаления в соответствии с GDPR. Побочный эффект: status='pending' запускает письмо с двойным подтверждением подписки. Аргументы: list_id: ID аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. email_address: Email нового участника. Не должен уже существовать в аудитории. status: 'subscribed' (по умолчанию), 'pending' (запускает письмо с подтверждением), 'unsubscribed', 'cleaned'. first_name: Имя (поле слияния FNAME). last_name: Фамилия (поле слияния LNAME). tags: Имена тегов через запятую (например 'VIP,Newsletter'). Создаются автоматически, если новые. Возвращает: JSON с id (MD5-хэш email), email_address, status, full_name.

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • statusstring
  • first_nameany
  • last_nameany
  • tagsany
  • accountany
add_member_event

Записывает пользовательское событие для участника аудитории (например, 'purchased', 'viewed_pricing'). Используется для логирования действий участника, которые могут запускать автоматизации или использоваться для сегментации. Используйте get_member_events для чтения записанных событий участника и get_member_goals для отслеживаемых Целей. Аргументы: list_id: ID списка/аудитории (10-значный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. email_address: Адрес электронной почты участника. Хеш подписчика вычисляется автоматически. name: Название события (буквы, цифры, подчёркивания; макс. 30 символов, например 'purchased'). properties: Необязательный словарь пользовательских пар ключ/значение, описывающих событие. Возвращает: JSON с подтверждением записи события или объект ошибки, если участник не найден или входные данные отклонены. При успехе Mailchimp API возвращает пустое тело (HTTP 204).

Записывает пользовательское событие для участника аудитории (например, 'purchased', 'viewed_pricing'). Используется для логирования действий участника, которые могут запускать автоматизации или использоваться для сегментации. Используйте get_member_events для чтения записанных событий участника и get_member_goals для отслеживаемых Целей. Аргументы: list_id: ID списка/аудитории (10-значный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. email_address: Адрес электронной почты участника. Хеш подписчика вычисляется автоматически. name: Название события (буквы, цифры, подчёркивания; макс. 30 символов, например 'purchased'). properties: Необязательный словарь пользовательских пар ключ/значение, описывающих событие. Возвращает: JSON с подтверждением записи события или объект ошибки, если участник не найден или входные данные отклонены. При успехе Mailchimp API возвращает пустое тело (HTTP 204).

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • namestringобязательный
  • propertiesany
  • accountany
add_member_note

Добавляет внутреннюю заметку в стиле CRM для участника. Не отправляется контакту. Полезно в контексте продаж/поддержки, например: «Попросил скидку на годовой план», «В отпуске до 1 июня». Используйте update_member_note, чтобы отредактировать существующую заметку вместо добавления новой. Возвращает 404, если участник не существует; возвращает 400, если текст заметки превышает 1000 символов. Аргументы: list_id: ID аудитории/списка. Получить из list_audiences. email_address: Email участника, к которому прикрепить заметку. Должен существовать в аудитории. note: Текст заметки (макс. 1000 символов). Обычный текст; Markdown не отображается в интерфейсе Mailchimp. Возвращает: JSON с полями id (используется как note_id), email_address, note, created_at, created_by.

Добавляет внутреннюю заметку в стиле CRM для участника. Не отправляется контакту. Полезно в контексте продаж/поддержки, например: «Попросил скидку на годовой план», «В отпуске до 1 июня». Используйте update_member_note, чтобы отредактировать существующую заметку вместо добавления новой. Возвращает 404, если участник не существует; возвращает 400, если текст заметки превышает 1000 символов. Аргументы: list_id: ID аудитории/списка. Получить из list_audiences. email_address: Email участника, к которому прикрепить заметку. Должен существовать в аудитории. note: Текст заметки (макс. 1000 символов). Обычный текст; Markdown не отображается в интерфейсе Mailchimp. Возвращает: JSON с полями id (используется как note_id), email_address, note, created_at, created_by.

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • notestringобязательный
  • accountany
add_members_to_segment

Добавляет участников в статический сегмент или тег по email. Работает только со статическими сегментами (тегами), не с динамическими. Участники уже должны существовать в аудитории. Для управления тегом с одним участником используйте tag_member. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. segment_id: ID статического сегмента/тега (строка из цифр, например '12345'). Получить из list_segments. emails: Email через запятую для добавления (например 'a@co.com,b@co.com'). Должны существовать в аудитории. Возвращает: JSON с total_added, total_removed (всегда 0), массив errors.

Добавляет участников в статический сегмент или тег по email. Работает только со статическими сегментами (тегами), не с динамическими. Участники уже должны существовать в аудитории. Для управления тегом с одним участником используйте tag_member. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. segment_id: ID статического сегмента/тега (строка из цифр, например '12345'). Получить из list_segments. emails: Email через запятую для добавления (например 'a@co.com,b@co.com'). Должны существовать в аудитории. Возвращает: JSON с total_added, total_removed (всегда 0), массив errors.

Параметры

  • list_idstringобязательный
  • segment_idstringобязательный
  • emailsstringобязательный
  • accountany
batch_subscribe

Добавляет или обновляет до 500 участников в одном синхронном запросе. Используйте для массовых операций. Выберите подходящий инструмент для работы с участниками: batch_subscribe для 2-500 участников, add_member или update_member для одного участника, create_batch для импорта более 500 участников. Побочный эффект: участники со статусом 'pending' получают письмо для двойного подтверждения подписки. Аргументы: list_id: Идентификатор аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. members_json: JSON-массив участников (макс. 500). Каждый требует email_address и status ('subscribed'/'unsubscribed'/'cleaned'/'pending'). Опционально: merge_fields, tags. update_existing: Если true (по умолчанию), существующие участники обновляются. Если false, пропускаются как ошибки. Возвращает: JSON с new_members, updated_members, errors array, total_created, total_updated, error_count.

Добавляет или обновляет до 500 участников в одном синхронном запросе. Используйте для массовых операций. Выберите подходящий инструмент для работы с участниками: batch_subscribe для 2-500 участников, add_member или update_member для одного участника, create_batch для импорта более 500 участников. Побочный эффект: участники со статусом 'pending' получают письмо для двойного подтверждения подписки. Аргументы: list_id: Идентификатор аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. members_json: JSON-массив участников (макс. 500). Каждый требует email_address и status ('subscribed'/'unsubscribed'/'cleaned'/'pending'). Опционально: merge_fields, tags. update_existing: Если true (по умолчанию), существующие участники обновляются. Если false, пропускаются как ошибки. Возвращает: JSON с new_members, updated_members, errors array, total_created, total_updated, error_count.

Параметры

  • list_idstringобязательный
  • members_jsonstringобязательный
  • update_existingboolean
  • accountany
cancel_send

Отменяет рассылку кампании прямо во время отправки — доставка оставшимся получателям прекращается. Работает только с кампаниями в статусе 'sending'. Уже отправленные письма отозвать нельзя. Необратимо. Для отложенных (ещё не отправляющихся) кампаний используйте unschedule_campaign. Аргументы: campaign_id: ID кампании (например, 'abc123def4'). Кампания должна быть в статусе 'sending'. Возвращает: JSON с полями status ("cancelled") и campaign_id. Вернёт ошибку, если кампания не в процессе отправки.

Отменяет рассылку кампании прямо во время отправки — доставка оставшимся получателям прекращается. Работает только с кампаниями в статусе 'sending'. Уже отправленные письма отозвать нельзя. Необратимо. Для отложенных (ещё не отправляющихся) кампаний используйте unschedule_campaign. Аргументы: campaign_id: ID кампании (например, 'abc123def4'). Кампания должна быть в статусе 'sending'. Возвращает: JSON с полями status ("cancelled") и campaign_id. Вернёт ошибку, если кампания не в процессе отправки.

Параметры

  • campaign_idstringобязательный
  • accountany
create_account_export

Запускает задание экспорта аккаунта для запрошенных категорий данных. Используется, чтобы получить архивируемую выгрузку данных аккаунта; опрашивай get_account_export, пока статус не станет finished, затем читай download_url. Перед запуском нового экспорта проверяй существующие с помощью list_account_exports. Аргументы: include_stages: Список названий этапов для включения в экспорт (например, ['lists', 'campaigns', 'reports', 'ecommerce']). Каждая указанная категория добавляется в архив экспорта. Возвращает: JSON с полями export_id, status, started (ISO 8601), finished (ISO 8601 или null), size_in_bytes, download_url.

Запускает задание экспорта аккаунта для запрошенных категорий данных. Используется, чтобы получить архивируемую выгрузку данных аккаунта; опрашивай get_account_export, пока статус не станет finished, затем читай download_url. Перед запуском нового экспорта проверяй существующие с помощью list_account_exports. Аргументы: include_stages: Список названий этапов для включения в экспорт (например, ['lists', 'campaigns', 'reports', 'ecommerce']). Каждая указанная категория добавляется в архив экспорта. Возвращает: JSON с полями export_id, status, started (ISO 8601), finished (ISO 8601 или null), size_in_bytes, download_url.

Параметры

  • include_stagesarrayобязательный
  • accountany
create_audience

Создать новую аудиторию (список) с обязательной контактной информацией, настройками кампаний по умолчанию и напоминанием о разрешении. Побочный эффект: создаёт платную аудиторию в тарифном плане Mailchimp. Mailchimp требует все контактные поля (компания, адрес, город, штат, индекс, страна) и текст напоминания о разрешении, соответствующий закону CAN-SPAM. Используйте update_audience, чтобы изменить позже, delete_audience для удаления, или list_audiences, чтобы проверить создание. Возвращает ошибку 400, если не хватает любого обязательного поля или превышен лимит аудиторий плана. Аргументы: - name: Отображаемое название аудитории в панели управления и при выборе аудитории (макс. 100 символов). - from_name: Имя отправителя по умолчанию для кампаний (например, 'Маркетинговая команда'). Макс. 100 символов. - from_email: Email отправителя по умолчанию. Должен быть на подтверждённом домене отправки. - subject: Тема письма по умолчанию для новых кампаний. Макс. 150 символов. - language: Код языка по умолчанию (например, 'en', 'fr', 'es'). Двухбуквенный код ISO 639-1. - company: Юридическое название компании, отображаемое в нижнем колонтитуле письма (требуется по CAN-SPAM). - address1: Основная строка почтового адреса в нижнем колонтитуле. - city: Город почтового адреса. - state: Штат или регион почтового адреса. - zip: Почтовый индекс / ZIP-код. - country: Двухбуквенный код страны по ISO (например, 'US', 'FR', 'GB'). - permission_reminder: Предложение внизу каждого письма, объясняющее, почему подписчик его получает (требуется по CAN-SPAM). - email_type_option: Если true, подписчики могут выбирать между обычным текстом и HTML-письмами. По умолчанию false. - address2: Дополнительная строка почтового адреса (необязательно). - phone: Контактный номер телефона, отображаемый в нижнем колонтитуле (необязательно). Возвращает: - JSON с полями id (новый list_id, сохраните для последующих вызовов), name, member_count (0 при создании), date_created, subscribe_url_short.

Создать новую аудиторию (список) с обязательной контактной информацией, настройками кампаний по умолчанию и напоминанием о разрешении. Побочный эффект: создаёт платную аудиторию в тарифном плане Mailchimp. Mailchimp требует все контактные поля (компания, адрес, город, штат, индекс, страна) и текст напоминания о разрешении, соответствующий закону CAN-SPAM. Используйте update_audience, чтобы изменить позже, delete_audience для удаления, или list_audiences, чтобы проверить создание. Возвращает ошибку 400, если не хватает любого обязательного поля или превышен лимит аудиторий плана. Аргументы: - name: Отображаемое название аудитории в панели управления и при выборе аудитории (макс. 100 символов). - from_name: Имя отправителя по умолчанию для кампаний (например, 'Маркетинговая команда'). Макс. 100 символов. - from_email: Email отправителя по умолчанию. Должен быть на подтверждённом домене отправки. - subject: Тема письма по умолчанию для новых кампаний. Макс. 150 символов. - language: Код языка по умолчанию (например, 'en', 'fr', 'es'). Двухбуквенный код ISO 639-1. - company: Юридическое название компании, отображаемое в нижнем колонтитуле письма (требуется по CAN-SPAM). - address1: Основная строка почтового адреса в нижнем колонтитуле. - city: Город почтового адреса. - state: Штат или регион почтового адреса. - zip: Почтовый индекс / ZIP-код. - country: Двухбуквенный код страны по ISO (например, 'US', 'FR', 'GB'). - permission_reminder: Предложение внизу каждого письма, объясняющее, почему подписчик его получает (требуется по CAN-SPAM). - email_type_option: Если true, подписчики могут выбирать между обычным текстом и HTML-письмами. По умолчанию false. - address2: Дополнительная строка почтового адреса (необязательно). - phone: Контактный номер телефона, отображаемый в нижнем колонтитуле (необязательно). Возвращает: - JSON с полями id (новый list_id, сохраните для последующих вызовов), name, member_count (0 при создании), date_created, subscribe_url_short.

Параметры

  • namestringобязательный
  • from_namestringобязательный
  • from_emailstringобязательный
  • subjectstringобязательный
  • languagestringобязательный
  • companystringобязательный
  • address1stringобязательный
  • citystringобязательный
  • statestringобязательный
  • zipstringобязательный
  • countrystringобязательный
  • permission_reminderstringобязательный
  • email_type_optionboolean
  • address2any
  • phoneany
  • accountany
create_batch

Отправляет несколько API-операций как единый асинхронный пакетный запрос. Используйте для массовых операций, превышающих лимиты других инструментов (например, batch_subscribe макс. 500). Операции выполняются асинхронно; опрашивайте статус через get_batch_status. Каждая операция выполняется независимо. Поскольку пакет может содержать произвольные DELETE, этот инструмент классифицируется как деструктивный, поэтому шлюз обрабатывает его с той же осторожностью, что и удаление. Аргументы: operations: JSON-массив операций. Каждая требует: method ('GET'/'POST'/'PATCH'/'PUT'/ 'DELETE'), path (эндпоинт API, например '/lists/abc123/members'), необязательный body (JSON-строка). Возвращает: JSON с id (идентификатор пакета для get_batch_status), status ('pending'), total_operations, submitted_at.

Отправляет несколько API-операций как единый асинхронный пакетный запрос. Используйте для массовых операций, превышающих лимиты других инструментов (например, batch_subscribe макс. 500). Операции выполняются асинхронно; опрашивайте статус через get_batch_status. Каждая операция выполняется независимо. Поскольку пакет может содержать произвольные DELETE, этот инструмент классифицируется как деструктивный, поэтому шлюз обрабатывает его с той же осторожностью, что и удаление. Аргументы: operations: JSON-массив операций. Каждая требует: method ('GET'/'POST'/'PATCH'/'PUT'/ 'DELETE'), path (эндпоинт API, например '/lists/abc123/members'), необязательный body (JSON-строка). Возвращает: JSON с id (идентификатор пакета для get_batch_status), status ('pending'), total_operations, submitted_at.

Параметры

  • operationsstringобязательный
  • accountany
create_batch_webhook

Создаёт новый batch-вебхук, который уведомляет URL по завершении пакетных операций. Используйте для получения обратных вызовов, когда пакетные задания завершаются, вместо опроса get_batch_status. Вызовите update_batch_webhook, чтобы позже изменить URL, и delete_batch_webhook, чтобы удалить его. Аргументы: url: URL обратного вызова, на который Mailchimp отправит POST-запрос по завершении пакета (должен быть общедоступным). Возвращает: JSON с полями id (новый batch_webhook_id), url, enabled (булево значение). Возвращает объект ошибки, если URL отклонён.

Создаёт новый batch-вебхук, который уведомляет URL по завершении пакетных операций. Используйте для получения обратных вызовов, когда пакетные задания завершаются, вместо опроса get_batch_status. Вызовите update_batch_webhook, чтобы позже изменить URL, и delete_batch_webhook, чтобы удалить его. Аргументы: url: URL обратного вызова, на который Mailchimp отправит POST-запрос по завершении пакета (должен быть общедоступным). Возвращает: JSON с полями id (новый batch_webhook_id), url, enabled (булево значение). Возвращает объект ошибки, если URL отклонён.

Параметры

  • urlstringобязательный
  • accountany
create_campaign

Создаёт новую email-кампанию в статусе черновика, с возможностью сегментного таргетинга или A/B-тестирования. Типичный рабочий процесс: create_campaign -> set_campaign_content (добавить HTML-тело) -> send_test_email (предпросмотр) -> send_campaign или schedule_campaign (отправка). Кампания создаётся в статусе 'save' (черновик) и не может быть отправлена, пока не задано содержимое. Используйте replicate_campaign вместо этого, чтобы клонировать существующую кампанию. Для A/B-тестирования укажите campaign_type='variate' и передайте variate_settings_json с описанием теста. Mailchimp отправит варианты части получателей, затем автоматически выберет победителя на основе winner_criteria и отправит его оставшейся аудитории после wait_time. Аргументы: list_id: ID аудитории/списка для отправки (например, 'abc123def4'). Получить из list_audiences. subject_line: Тема письма, которую получатели видят в папке «Входящие». Не более 150 символов. Для тестовых кампаний с проверкой тем письма это значение используется как запасное/базовое. title: Внутреннее название для организации кампании в панели управления Mailchimp. Если не указано, по умолчанию равно subject_line. preview_text: Текст прехедера, отображаемый после темы письма во входящих. Не более 200 символов. from_name: Имя отправителя в письме. Если не указано, используется значение по умолчанию из настроек аудитории. reply_to: Адрес электронной почты для ответов. Должен быть с подтверждённого домена. Если не указан, используется значение по умолчанию из настроек аудитории. segment_id: ID сохранённого сегмента для ограничения получателей. Письмо получат только подписчики, соответствующие этому сегменту. Получить из list_segments. Опустите, чтобы отправить всей аудитории. campaign_type: 'regular' (по умолчанию) для обычной кампании или 'variate' для A/B-теста. Также принимаются 'plaintext', 'rss' и 'absplit' (устаревший A/B), но используются редко. variate_settings_json: Обязателен, если campaign_type='variate'. JSON-строка с ключами: winner_criteria ('opens' | 'clicks' | 'manual' | 'total_revenue'), test_size (10-100, процент аудитории в выборке), wait_time (минуты до выбора победителя) и одно из subject_lines (список из 2-8…

Создаёт новую email-кампанию в статусе черновика, с возможностью сегментного таргетинга или A/B-тестирования. Типичный рабочий процесс: create_campaign -> set_campaign_content (добавить HTML-тело) -> send_test_email (предпросмотр) -> send_campaign или schedule_campaign (отправка). Кампания создаётся в статусе 'save' (черновик) и не может быть отправлена, пока не задано содержимое. Используйте replicate_campaign вместо этого, чтобы клонировать существующую кампанию. Для A/B-тестирования укажите campaign_type='variate' и передайте variate_settings_json с описанием теста. Mailchimp отправит варианты части получателей, затем автоматически выберет победителя на основе winner_criteria и отправит его оставшейся аудитории после wait_time. Аргументы: list_id: ID аудитории/списка для отправки (например, 'abc123def4'). Получить из list_audiences. subject_line: Тема письма, которую получатели видят в папке «Входящие». Не более 150 символов. Для тестовых кампаний с проверкой тем письма это значение используется как запасное/базовое. title: Внутреннее название для организации кампании в панели управления Mailchimp. Если не указано, по умолчанию равно subject_line. preview_text: Текст прехедера, отображаемый после темы письма во входящих. Не более 200 символов. from_name: Имя отправителя в письме. Если не указано, используется значение по умолчанию из настроек аудитории. reply_to: Адрес электронной почты для ответов. Должен быть с подтверждённого домена. Если не указан, используется значение по умолчанию из настроек аудитории. segment_id: ID сохранённого сегмента для ограничения получателей. Письмо получат только подписчики, соответствующие этому сегменту. Получить из list_segments. Опустите, чтобы отправить всей аудитории. campaign_type: 'regular' (по умолчанию) для обычной кампании или 'variate' для A/B-теста. Также принимаются 'plaintext', 'rss' и 'absplit' (устаревший A/B), но используются редко. variate_settings_json: Обязателен, если campaign_type='variate'. JSON-строка с ключами: winner_criteria ('opens' | 'clicks' | 'manual' | 'total_revenue'), test_size (10-100, процент аудитории в выборке), wait_time (минуты до выбора победителя) и одно из subject_lines (список из 2-8…

Параметры

  • list_idstringобязательный
  • subject_linestringобязательный
  • titleany
  • preview_textany
  • from_nameany
  • reply_toany
  • segment_idany
  • campaign_typestring
  • variate_settings_jsonany
  • accountany
create_campaign_feedback

Добавляет комментарий с отзывом для командной работы в кампанию. Используйте, чтобы оставлять заметки коллегам при подготовке кампании. Опционально прикрепите комментарий к конкретному блоку контента через block_id. Используйте list_campaign_feedback для просмотра существующих комментариев. Аргументы: campaign_id: Идентификатор кампании, к которой добавляется комментарий. Получить из list_campaigns или search_campaigns. message: Текст комментария с отзывом. block_id: Опциональный идентификатор блока контента, к которому прикрепляется комментарий. Возвращает: JSON с полями feedback_id, message, is_complete, block_id, created_by, created_at.

Добавляет комментарий с отзывом для командной работы в кампанию. Используйте, чтобы оставлять заметки коллегам при подготовке кампании. Опционально прикрепите комментарий к конкретному блоку контента через block_id. Используйте list_campaign_feedback для просмотра существующих комментариев. Аргументы: campaign_id: Идентификатор кампании, к которой добавляется комментарий. Получить из list_campaigns или search_campaigns. message: Текст комментария с отзывом. block_id: Опциональный идентификатор блока контента, к которому прикрепляется комментарий. Возвращает: JSON с полями feedback_id, message, is_complete, block_id, created_by, created_at.

Параметры

  • campaign_idstringобязательный
  • messagestringобязательный
  • block_idany
  • accountany
create_campaign_folder

Создайте новую папку для организации кампаний. Группируйте связанные кампании (например, по клиенту, месяцу или теме), чтобы упростить навигацию. Присваивайте кампании папке через поле folder_id при их создании или обновлении. Используйте list_campaign_folders для просмотра существующих папок. Аргументы: name: Отображаемое название новой папки (например, 'Q3 Newsletters'). Возвращает: JSON с id (идентификатор новой папки), name и count (количество кампаний в папке).

Создайте новую папку для организации кампаний. Группируйте связанные кампании (например, по клиенту, месяцу или теме), чтобы упростить навигацию. Присваивайте кампании папке через поле folder_id при их создании или обновлении. Используйте list_campaign_folders для просмотра существующих папок. Аргументы: name: Отображаемое название новой папки (например, 'Q3 Newsletters'). Возвращает: JSON с id (идентификатор новой папки), name и count (количество кампаний в папке).

Параметры

  • namestringобязательный
  • accountany
create_connected_site

Подключает сайт к Mailchimp, генерируя скрипт отслеживания для этого домена. Используйте, чтобы включить отслеживание сайта и всплывающие формы на домене, которым вы управляете. После создания установите полученный скрипт, затем вызовите `verify_connected_site_script`, чтобы подтвердить установку. Сначала проверьте существующие сайты через `list_connected_sites`. Аргументы: - `foreign_id`: Уникальный идентификатор для этого сайта на ваше усмотрение (например, 'my-store'). - `domain`: Домен сайта для подключения (например, 'www.example.com'). Возвращает: JSON с полями: id, foreign_id, domain, site_script (объект с url и fragment), status, created_at, updated_at.

Подключает сайт к Mailchimp, генерируя скрипт отслеживания для этого домена. Используйте, чтобы включить отслеживание сайта и всплывающие формы на домене, которым вы управляете. После создания установите полученный скрипт, затем вызовите `verify_connected_site_script`, чтобы подтвердить установку. Сначала проверьте существующие сайты через `list_connected_sites`. Аргументы: - `foreign_id`: Уникальный идентификатор для этого сайта на ваше усмотрение (например, 'my-store'). - `domain`: Домен сайта для подключения (например, 'www.example.com'). Возвращает: JSON с полями: id, foreign_id, domain, site_script (объект с url и fragment), status, created_at, updated_at.

Параметры

  • foreign_idstringобязательный
  • domainstringобязательный
  • accountany
create_interest

Создаёт новый вариант интереса внутри категории интересов (например, добавляет "Tech" в категорию "Topics"). Используйте после create_interest_category, чтобы добавить выбираемые параметры. Каждый параметр становится доступен на формах регистрации (если тип категории не 'hidden'). Чтобы проверить уже существующие параметры, используйте list_interests. Чтобы удалить параметр, используйте delete_interest. Аргументы: list_id: идентификатор аудитории/списка Mailchimp (например, 'abc123def4'). Получите из list_audiences. category_id: идентификатор категории интересов. Получите из list_interest_categories или create_interest_category. name: отображаемое название параметра интереса (например, 'Tech', 'Sports'). Должно быть уникальным в пределах категории. Возвращает: JSON с полями: id (строка, используется с delete_interest), name, subscriber_count (целое число, начинается с 0). Пример: create_interest(list_id="abc123", category_id="cat456", name="Technology") -> {"id": "int789", "name": "Technology", "subscriber_count": 0}

Создаёт новый вариант интереса внутри категории интересов (например, добавляет "Tech" в категорию "Topics"). Используйте после create_interest_category, чтобы добавить выбираемые параметры. Каждый параметр становится доступен на формах регистрации (если тип категории не 'hidden'). Чтобы проверить уже существующие параметры, используйте list_interests. Чтобы удалить параметр, используйте delete_interest. Аргументы: list_id: идентификатор аудитории/списка Mailchimp (например, 'abc123def4'). Получите из list_audiences. category_id: идентификатор категории интересов. Получите из list_interest_categories или create_interest_category. name: отображаемое название параметра интереса (например, 'Tech', 'Sports'). Должно быть уникальным в пределах категории. Возвращает: JSON с полями: id (строка, используется с delete_interest), name, subscriber_count (целое число, начинается с 0). Пример: create_interest(list_id="abc123", category_id="cat456", name="Technology") -> {"id": "int789", "name": "Technology", "subscriber_count": 0}

Параметры

  • list_idstringобязательный
  • category_idstringобязательный
  • namestringобязательный
  • accountany
create_interest_category

Создайте новую категорию интересов (групповой контейнер) в аудитории для организации предпочтений подписчиков. Используется для создания контейнера для вариантов интересов. Типичный рабочий процесс: create_interest_category -> create_interest (добавить варианты внутри категории). Параметр type определяет, как подписчики взаимодействуют с ним на формах регистрации. Сначала используйте list_interest_categories, чтобы проверить существующие категории. Args: list_id: Идентификатор аудитории/списка Mailchimp (например, 'abc123def4'). Получить из list_audiences. title: Отображаемый заголовок категории (например, 'Preferred Topics'). Должен быть уникальным в пределах аудитории. type: Как категория отображается на формах регистрации. Допустимые значения: 'checkboxes' (подписчики могут выбрать несколько), 'dropdown' (одиночный выбор), 'radio' (одиночный выбор), 'hidden' (не показывается на формах, управляется только через API). Returns: JSON со следующими полями: id (строка, используется с create_interest, list_interests, delete_interest_category), title, type, list_id. Example: create_interest_category(list_id="abc123", title="Newsletter Preferences", type="checkboxes") -> {"id": "cat456", "title": "Newsletter Preferences", "type": "checkboxes", ...}

Создайте новую категорию интересов (групповой контейнер) в аудитории для организации предпочтений подписчиков. Используется для создания контейнера для вариантов интересов. Типичный рабочий процесс: create_interest_category -> create_interest (добавить варианты внутри категории). Параметр type определяет, как подписчики взаимодействуют с ним на формах регистрации. Сначала используйте list_interest_categories, чтобы проверить существующие категории. Args: list_id: Идентификатор аудитории/списка Mailchimp (например, 'abc123def4'). Получить из list_audiences. title: Отображаемый заголовок категории (например, 'Preferred Topics'). Должен быть уникальным в пределах аудитории. type: Как категория отображается на формах регистрации. Допустимые значения: 'checkboxes' (подписчики могут выбрать несколько), 'dropdown' (одиночный выбор), 'radio' (одиночный выбор), 'hidden' (не показывается на формах, управляется только через API). Returns: JSON со следующими полями: id (строка, используется с create_interest, list_interests, delete_interest_category), title, type, list_id. Example: create_interest_category(list_id="abc123", title="Newsletter Preferences", type="checkboxes") -> {"id": "cat456", "title": "Newsletter Preferences", "type": "checkboxes", ...}

Параметры

  • list_idstringобязательный
  • titlestringобязательный
  • typestringобязательный
  • accountany
create_landing_page

Создаёт новую целевую страницу в статусе черновика на основе шаблона, опционально привязанную к магазину. Страница создаётся неопубликованной. Используйте update_landing_page для редактирования настроек или publish_landing_page для публикации по её публичному URL. Используйте list_landing_pages или get_landing_page для просмотра существующих страниц. Возвращает ошибку 400, если template_id недействителен или list_id не существует. Args: name: Внутреннее имя страницы (отображается в панели управления Mailchimp, не для посетителей). title: Заголовок вкладки браузера (отображается в HTML-теге <title> страницы). list_id: ID аудитории, для которой эта страница собирает регистрации (например, 'abc123def4'). Получите из list_audiences. template_id: ID шаблона, на основе которого создаётся страница. Получите из list_templates. store_id: Опциональный ID магазина электронной коммерции для привязки страницы. Получите из list_ecommerce_stores. description: Опциональное внутреннее описание. tracking_opens: Отслеживать аналитику просмотров. По умолчанию true. tracking_clicks: Отслеживать аналитику кликов по ссылкам. По умолчанию true. Returns: JSON с полями id (используйте как page_id для последующих вызовов), name, title, status ('unpublished'), url (null до публикации), created_at, list_id.

Создаёт новую целевую страницу в статусе черновика на основе шаблона, опционально привязанную к магазину. Страница создаётся неопубликованной. Используйте update_landing_page для редактирования настроек или publish_landing_page для публикации по её публичному URL. Используйте list_landing_pages или get_landing_page для просмотра существующих страниц. Возвращает ошибку 400, если template_id недействителен или list_id не существует. Args: name: Внутреннее имя страницы (отображается в панели управления Mailchimp, не для посетителей). title: Заголовок вкладки браузера (отображается в HTML-теге <title> страницы). list_id: ID аудитории, для которой эта страница собирает регистрации (например, 'abc123def4'). Получите из list_audiences. template_id: ID шаблона, на основе которого создаётся страница. Получите из list_templates. store_id: Опциональный ID магазина электронной коммерции для привязки страницы. Получите из list_ecommerce_stores. description: Опциональное внутреннее описание. tracking_opens: Отслеживать аналитику просмотров. По умолчанию true. tracking_clicks: Отслеживать аналитику кликов по ссылкам. По умолчанию true. Returns: JSON с полями id (используйте как page_id для последующих вызовов), name, title, status ('unpublished'), url (null до публикации), created_at, list_id.

Параметры

  • namestringобязательный
  • titlestringобязательный
  • list_idstringобязательный
  • template_idstringобязательный
  • store_idany
  • descriptionany
  • tracking_opensboolean
  • tracking_clicksboolean
  • accountany
create_merge_field

Создаёт новое пользовательское поле слияния в аудитории для хранения дополнительных данных о подписчиках. Используется для добавления пользовательских полей данных помимо стандартных (FNAME, LNAME, ADDRESS, PHONE). После создания заполняется для каждого подписчика через add_member/update_member с использованием имени тега. Тип нельзя изменить после создания. Сначала используйте list_merge_fields для проверки существующих полей. Аргументы: list_id: Идентификатор аудитории/списка Mailchimp (например, 'abc123def4'). Получить из list_audiences. name: Отображаемое имя поля (например, 'Company Name'). type: Тип данных поля. Допустимые значения: 'text', 'number', 'address', 'date', 'birthday', 'phone', 'url', 'imageurl', 'zip', 'dropdown', 'radio'. Нельзя изменить после создания. tag: Короткое имя тега в верхнем регистре (например, 'COMPANY'). Максимум 10 символов, только буквы и цифры. Генерируется автоматически из name, если не указан. Используется как *|TAG|* в содержимом письма. required: Обязательность поля при подписке (по умолчанию false). default_value: Значение по умолчанию для новых подписчиков. choices: Значения через запятую для типов 'dropdown' или 'radio' (например, 'Small,Medium,Large'). Обязательно, если type равен 'dropdown' или 'radio'. Для других типов игнорируется. Возвращает: JSON с полями: merge_id (int, для обновления/удаления), tag (string), name, type, required. Пример: create_merge_field(list_id="abc123", name="Company", type="text", tag="COMPANY") -> {"merge_id": 5, "tag": "COMPANY", "name": "Company", "type": "text", ...}

Создаёт новое пользовательское поле слияния в аудитории для хранения дополнительных данных о подписчиках. Используется для добавления пользовательских полей данных помимо стандартных (FNAME, LNAME, ADDRESS, PHONE). После создания заполняется для каждого подписчика через add_member/update_member с использованием имени тега. Тип нельзя изменить после создания. Сначала используйте list_merge_fields для проверки существующих полей. Аргументы: list_id: Идентификатор аудитории/списка Mailchimp (например, 'abc123def4'). Получить из list_audiences. name: Отображаемое имя поля (например, 'Company Name'). type: Тип данных поля. Допустимые значения: 'text', 'number', 'address', 'date', 'birthday', 'phone', 'url', 'imageurl', 'zip', 'dropdown', 'radio'. Нельзя изменить после создания. tag: Короткое имя тега в верхнем регистре (например, 'COMPANY'). Максимум 10 символов, только буквы и цифры. Генерируется автоматически из name, если не указан. Используется как *|TAG|* в содержимом письма. required: Обязательность поля при подписке (по умолчанию false). default_value: Значение по умолчанию для новых подписчиков. choices: Значения через запятую для типов 'dropdown' или 'radio' (например, 'Small,Medium,Large'). Обязательно, если type равен 'dropdown' или 'radio'. Для других типов игнорируется. Возвращает: JSON с полями: merge_id (int, для обновления/удаления), tag (string), name, type, required. Пример: create_merge_field(list_id="abc123", name="Company", type="text", tag="COMPANY") -> {"merge_id": 5, "tag": "COMPANY", "name": "Company", "type": "text", ...}

Параметры

  • list_idstringобязательный
  • namestringобязательный
  • typestringобязательный
  • tagany
  • requiredboolean
  • default_valueany
  • choicesany
  • accountany
create_promo_code

Создаёт активируемый промо-код для существующего правила. Покупатели вводят строку `code` на кассе, чтобы применить скидку по правилу. Сравнение кода не чувствительно к регистру на стороне Mailchimp. Используйте list_promo_codes, чтобы проверить существующие коды перед созданием дубликатов. Возвращает 400, если promo_rule_id не существует; возвращает 409, если promo_code_id уже существует. Аргументы: - store_id — ID магазина электронной коммерции. - promo_rule_id — ID правила, к которому привязывается код. Получить через list_promo_rules. - promo_code_id — уникальный ID кода от клиента. - code — строка, которую покупатели вводят на кассе (например, 'SUMMER20'). - redemption_url — URL, где можно применить код (ваша страница оформления заказа). - enabled — активен ли код. По умолчанию true. Возвращает: JSON с полями id, code, redemption_url, usage_count (0 при создании), enabled, created_at.

Создаёт активируемый промо-код для существующего правила. Покупатели вводят строку `code` на кассе, чтобы применить скидку по правилу. Сравнение кода не чувствительно к регистру на стороне Mailchimp. Используйте list_promo_codes, чтобы проверить существующие коды перед созданием дубликатов. Возвращает 400, если promo_rule_id не существует; возвращает 409, если promo_code_id уже существует. Аргументы: - store_id — ID магазина электронной коммерции. - promo_rule_id — ID правила, к которому привязывается код. Получить через list_promo_rules. - promo_code_id — уникальный ID кода от клиента. - code — строка, которую покупатели вводят на кассе (например, 'SUMMER20'). - redemption_url — URL, где можно применить код (ваша страница оформления заказа). - enabled — активен ли код. По умолчанию true. Возвращает: JSON с полями id, code, redemption_url, usage_count (0 при создании), enabled, created_at.

Параметры

  • store_idstringобязательный
  • promo_rule_idstringобязательный
  • promo_code_idstringобязательный
  • codestringобязательный
  • redemption_urlstringобязательный
  • enabledboolean
  • accountany
create_promo_rule

Создаёт правило акции (механизм скидки) в магазине. После этого к нему можно привязать коды через create_promo_code. promo_rule_id задаётся клиентом. Типовые комбинации: amount=20 + type='percentage' + target='total' — скидка 20% на весь заказ; amount=5 + type='fixed' + target='shipping' — скидка $5 на доставку. Аргументы: - store_id — ID интернет-магазина. - promo_rule_id — уникальный ID правила, задаётся клиентом. - description — внутреннее описание, показывается в интерфейсе Mailchimp. - amount — размер скидки. Для type='percentage' — значение от 0 до 100. - type — 'fixed' (фиксированная сумма) или 'percentage' (процент). - target — 'per_item' (на каждый товар), 'total' (весь заказ) или 'shipping' (только доставка). - enabled — активно ли правило. По умолчанию true. - title — опциональное публичное название. - starts_at — опциональная дата начала в формате ISO 8601 (правило неактивно до этого времени). - ends_at — опциональная дата окончания в формате ISO 8601 (правило неактивно после этого времени). Возвращает: - JSON с полями id, title, description, amount, type, target, enabled, created_at.

Создаёт правило акции (механизм скидки) в магазине. После этого к нему можно привязать коды через create_promo_code. promo_rule_id задаётся клиентом. Типовые комбинации: amount=20 + type='percentage' + target='total' — скидка 20% на весь заказ; amount=5 + type='fixed' + target='shipping' — скидка $5 на доставку. Аргументы: - store_id — ID интернет-магазина. - promo_rule_id — уникальный ID правила, задаётся клиентом. - description — внутреннее описание, показывается в интерфейсе Mailchimp. - amount — размер скидки. Для type='percentage' — значение от 0 до 100. - type — 'fixed' (фиксированная сумма) или 'percentage' (процент). - target — 'per_item' (на каждый товар), 'total' (весь заказ) или 'shipping' (только доставка). - enabled — активно ли правило. По умолчанию true. - title — опциональное публичное название. - starts_at — опциональная дата начала в формате ISO 8601 (правило неактивно до этого времени). - ends_at — опциональная дата окончания в формате ISO 8601 (правило неактивно после этого времени). Возвращает: - JSON с полями id, title, description, amount, type, target, enabled, created_at.

Параметры

  • store_idstringобязательный
  • promo_rule_idstringобязательный
  • descriptionstringобязательный
  • amountnumberобязательный
  • typestringобязательный
  • targetstringобязательный
  • enabledboolean
  • titleany
  • starts_atany
  • ends_atany
  • accountany
create_segment

Создаёт новый сегмент или тег в аудитории для группировки участников. Статические сегменты (по умолчанию) — членство назначается вручную через add_members_to_segment. Динамические сегменты обновляются автоматически по условиям фильтрации. Безопасно, побочных эффектов нет. Для назначения тегов отдельным участникам используйте tag_member. Аргументы: - list_id: ID аудитории (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. - name: Отображаемое имя сегмента или тега. - static: True (по умолчанию) — ручное членство; false — динамическое (требует match + conditions_json). - match: Логика условий для динамических сегментов: 'all' (И) или 'any' (ИЛИ). Обязателен, если static=false. - conditions_json: Массив условий JSON для динамических сегментов. Обязателен, если static=false. Возвращает: - JSON с полями id (новый ID сегмента), name, member_count, type ('static'/'saved'), options.

Создаёт новый сегмент или тег в аудитории для группировки участников. Статические сегменты (по умолчанию) — членство назначается вручную через add_members_to_segment. Динамические сегменты обновляются автоматически по условиям фильтрации. Безопасно, побочных эффектов нет. Для назначения тегов отдельным участникам используйте tag_member. Аргументы: - list_id: ID аудитории (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. - name: Отображаемое имя сегмента или тега. - static: True (по умолчанию) — ручное членство; false — динамическое (требует match + conditions_json). - match: Логика условий для динамических сегментов: 'all' (И) или 'any' (ИЛИ). Обязателен, если static=false. - conditions_json: Массив условий JSON для динамических сегментов. Обязателен, если static=false. Возвращает: - JSON с полями id (новый ID сегмента), name, member_count, type ('static'/'saved'), options.

Параметры

  • list_idstringобязательный
  • namestringобязательный
  • staticboolean
  • matchany
  • conditions_jsonany
  • accountany
create_store

Создаёт магазин электронной коммерции в Mailchimp для хранения товаров, клиентов, корзин и заказов. Магазин — это контейнер верхнего уровня, который связывает данные о покупках с аудиторией для сегментации и рекомендаций товаров. Многие магазины синхронизируются автоматически через интеграции с Shopify или WooCommerce; ручная запись подходит для кастомных или headless-витрин. Аргументы: store_id: Уникальный идентификатор нового магазина, предоставленный клиентом (например, 'store_1'). name: Человекочитаемое название магазина, отображаемое в интерфейсе Mailchimp. currency_code: Код валюты по стандарту ISO 4217 (например, 'USD', 'EUR'). additional_fields: Необязательный словарь дополнительных документированных полей (например, list_id, domain, email_address, primary_locale, timezone), объединяемых с телом запроса. Возвращает: JSON с созданным объектом магазина.

Создаёт магазин электронной коммерции в Mailchimp для хранения товаров, клиентов, корзин и заказов. Магазин — это контейнер верхнего уровня, который связывает данные о покупках с аудиторией для сегментации и рекомендаций товаров. Многие магазины синхронизируются автоматически через интеграции с Shopify или WooCommerce; ручная запись подходит для кастомных или headless-витрин. Аргументы: store_id: Уникальный идентификатор нового магазина, предоставленный клиентом (например, 'store_1'). name: Человекочитаемое название магазина, отображаемое в интерфейсе Mailchimp. currency_code: Код валюты по стандарту ISO 4217 (например, 'USD', 'EUR'). additional_fields: Необязательный словарь дополнительных документированных полей (например, list_id, domain, email_address, primary_locale, timezone), объединяемых с телом запроса. Возвращает: JSON с созданным объектом магазина.

Параметры

  • store_idstringобязательный
  • namestringобязательный
  • currency_codestringобязательный
  • additional_fieldsany
  • accountany
create_store_cart

Создаёт корзину в магазине с товарными позициями и ссылкой на покупателя. Используется для передачи данных брошенных корзин из внешней системы в Mailchimp для сценариев восстановления. cart_id указывает клиент (Mailchimp не генерирует его автоматически). Покупатель уже должен существовать в магазине; если нет — сначала создайте его через конечные точки Mailchimp для покупателей. Для изменения корзины после создания используйте update_store_cart. Аргументы: store_id — ID магазина электронной коммерции. cart_id — уникальный ID новой корзины, который указывает клиент (например 'cart_42'). customer_id — ID существующего покупателя в магазине. currency_code — код валюты по ISO 4217 (например 'USD', 'EUR'). order_total — общая сумма заказа (товарные позиции + налог + доставка, если есть). lines_json — JSON-строка с массивом товарных позиций корзины. Пример: '[{"id": "line_1", "product_id": "p_1", "product_variant_id": "p_1_red", "quantity": 2, "price": 19.99}]' checkout_url — опциональный URL для продолжения оформления корзины (используется в письмах о восстановлении). tax_total — опциональная часть налога в order_total. Возвращает: JSON с полями id, customer, currency_code, order_total, checkout_url, created_at.

Создаёт корзину в магазине с товарными позициями и ссылкой на покупателя. Используется для передачи данных брошенных корзин из внешней системы в Mailchimp для сценариев восстановления. cart_id указывает клиент (Mailchimp не генерирует его автоматически). Покупатель уже должен существовать в магазине; если нет — сначала создайте его через конечные точки Mailchimp для покупателей. Для изменения корзины после создания используйте update_store_cart. Аргументы: store_id — ID магазина электронной коммерции. cart_id — уникальный ID новой корзины, который указывает клиент (например 'cart_42'). customer_id — ID существующего покупателя в магазине. currency_code — код валюты по ISO 4217 (например 'USD', 'EUR'). order_total — общая сумма заказа (товарные позиции + налог + доставка, если есть). lines_json — JSON-строка с массивом товарных позиций корзины. Пример: '[{"id": "line_1", "product_id": "p_1", "product_variant_id": "p_1_red", "quantity": 2, "price": 19.99}]' checkout_url — опциональный URL для продолжения оформления корзины (используется в письмах о восстановлении). tax_total — опциональная часть налога в order_total. Возвращает: JSON с полями id, customer, currency_code, order_total, checkout_url, created_at.

Параметры

  • store_idstringобязательный
  • cart_idstringобязательный
  • customer_idstringобязательный
  • currency_codestringобязательный
  • order_totalnumberобязательный
  • lines_jsonstringобязательный
  • checkout_urlany
  • tax_totalany
  • accountany
create_store_customer

Создаёт клиента в магазине, привязывая его покупательскую активность к адресу электронной почты. opt_in_status определяет, добавляется ли клиент в подключённую аудиторию магазина как подписчик. Многие магазины синхронизируют клиентов автоматически через интеграции с Shopify или WooCommerce; эти ручные записи подходят для кастомных или headless витрин. Аргументы: store_id: идентификатор магазина электронной коммерции. customer_id: уникальный идентификатор нового клиента, предоставленный клиентом. email_address: адрес электронной почты клиента. opt_in_status: нужно ли подписать клиента на подключённую аудиторию (bool). additional_fields: необязательный словарь дополнительных документированных полей (например, first_name, last_name, company, address), объединяемых с телом запроса. Возвращает: JSON с созданным объектом клиента.

Создаёт клиента в магазине, привязывая его покупательскую активность к адресу электронной почты. opt_in_status определяет, добавляется ли клиент в подключённую аудиторию магазина как подписчик. Многие магазины синхронизируют клиентов автоматически через интеграции с Shopify или WooCommerce; эти ручные записи подходят для кастомных или headless витрин. Аргументы: store_id: идентификатор магазина электронной коммерции. customer_id: уникальный идентификатор нового клиента, предоставленный клиентом. email_address: адрес электронной почты клиента. opt_in_status: нужно ли подписать клиента на подключённую аудиторию (bool). additional_fields: необязательный словарь дополнительных документированных полей (например, first_name, last_name, company, address), объединяемых с телом запроса. Возвращает: JSON с созданным объектом клиента.

Параметры

  • store_idstringобязательный
  • customer_idstringобязательный
  • email_addressstringобязательный
  • opt_in_statusbooleanобязательный
  • additional_fieldsany
  • accountany
create_store_order

Создаёт заказ в интернет-магазине с покупателем и товарными позициями. order_id указывает клиент, и он должен быть уникальным в пределах магазина; покупатель уже должен существовать или быть передан встроенно с обязательным id. Ручная торговля подходит для кастомных магазинов без фронтенда; интеграции Shopify и WooCommerce синхронизируют заказы автоматически. Аргументы: store_id: Идентификатор интернет-магазина. Получите из list_ecommerce_stores. order_id: Уникальный ID нового заказа, указываемый клиентом (например, 'order_42'). customer: Словарь объекта покупателя. Обязательное поле 'id'; может включать email_address, opt_in_status, first_name, last_name. lines: Список словарей товарных позиций. Каждый содержит id, product_id, product_variant_id, quantity, price. additional_fields: Необязательный словарь дополнительных полей заказа, сливаемых в тело (например, currency_code, order_total, financial_status, processed_at_foreign, promos). Возвращает: JSON с созданным объектом заказа.

Создаёт заказ в интернет-магазине с покупателем и товарными позициями. order_id указывает клиент, и он должен быть уникальным в пределах магазина; покупатель уже должен существовать или быть передан встроенно с обязательным id. Ручная торговля подходит для кастомных магазинов без фронтенда; интеграции Shopify и WooCommerce синхронизируют заказы автоматически. Аргументы: store_id: Идентификатор интернет-магазина. Получите из list_ecommerce_stores. order_id: Уникальный ID нового заказа, указываемый клиентом (например, 'order_42'). customer: Словарь объекта покупателя. Обязательное поле 'id'; может включать email_address, opt_in_status, first_name, last_name. lines: Список словарей товарных позиций. Каждый содержит id, product_id, product_variant_id, quantity, price. additional_fields: Необязательный словарь дополнительных полей заказа, сливаемых в тело (например, currency_code, order_total, financial_status, processed_at_foreign, promos). Возвращает: JSON с созданным объектом заказа.

Параметры

  • store_idstringобязательный
  • order_idstringобязательный
  • customerobjectобязательный
  • linesarrayобязательный
  • additional_fieldsany
  • accountany
create_store_order_line

Добавляет строку товара в существующий заказ электронной коммерции. `line_id` предоставляется клиентом и должен быть уникальным в рамках заказа; `product_id` и `product_variant_id` должны ссылаться на товары, которые уже существуют в магазине. Ручное добавление строк подходит для пользовательских и headless-магазинов; интеграции с Shopify и WooCommerce синхронизируют строки заказов автоматически. Args: store_id: Идентификатор магазина электронной коммерции. Получите из list_ecommerce_stores. order_id: Идентификатор заказа, в который нужно добавить строку. line_id: Уникальный идентификатор новой строки, предоставленный клиентом (например, 'line_1'). product_id: Идентификатор существующего товара в магазине. product_variant_id: Идентификатор существующего варианта этого товара. quantity: Заказанное количество. price: Цена за единицу строки товара. additional_fields: Необязательный словарь дополнительных полей строки, объединяемых в тело запроса (например, скидка). Returns: JSON с созданным объектом строки.

Добавляет строку товара в существующий заказ электронной коммерции. `line_id` предоставляется клиентом и должен быть уникальным в рамках заказа; `product_id` и `product_variant_id` должны ссылаться на товары, которые уже существуют в магазине. Ручное добавление строк подходит для пользовательских и headless-магазинов; интеграции с Shopify и WooCommerce синхронизируют строки заказов автоматически. Args: store_id: Идентификатор магазина электронной коммерции. Получите из list_ecommerce_stores. order_id: Идентификатор заказа, в который нужно добавить строку. line_id: Уникальный идентификатор новой строки, предоставленный клиентом (например, 'line_1'). product_id: Идентификатор существующего товара в магазине. product_variant_id: Идентификатор существующего варианта этого товара. quantity: Заказанное количество. price: Цена за единицу строки товара. additional_fields: Необязательный словарь дополнительных полей строки, объединяемых в тело запроса (например, скидка). Returns: JSON с созданным объектом строки.

Параметры

  • store_idstringобязательный
  • order_idstringобязательный
  • line_idstringобязательный
  • product_idstringобязательный
  • product_variant_idstringобязательный
  • quantityintegerобязательный
  • pricenumberобязательный
  • additional_fieldsany
  • accountany
create_store_product

Создаёт товар в магазине, включая как минимум один вариант. Каждому товару нужен один или несколько вариантов; у простого товара все равно есть один вариант по умолчанию. Многие магазины синхронизируют товары автоматически через интеграции с Shopify или WooCommerce; эти ручные записи подходят для кастомных или headless витрин. Args: store_id: Идентификатор магазина электронной коммерции. product_id: Уникальный идентификатор нового товара, предоставляемый клиентом. title: Название товара, отображаемое в письмах и интерфейсе Mailchimp. variants: Список словарей вариантов (минимум 1), каждый из которых содержит как минимум id и title (например, [{"id": "v1", "title": "Default", "price": 19.99}]). additional_fields: Необязательный словарь дополнительных документированных полей (например, handle, url, description, type, vendor, image_url, images), объединяемых с телом запроса. Returns: JSON с созданным объектом товара.

Создаёт товар в магазине, включая как минимум один вариант. Каждому товару нужен один или несколько вариантов; у простого товара все равно есть один вариант по умолчанию. Многие магазины синхронизируют товары автоматически через интеграции с Shopify или WooCommerce; эти ручные записи подходят для кастомных или headless витрин. Args: store_id: Идентификатор магазина электронной коммерции. product_id: Уникальный идентификатор нового товара, предоставляемый клиентом. title: Название товара, отображаемое в письмах и интерфейсе Mailchimp. variants: Список словарей вариантов (минимум 1), каждый из которых содержит как минимум id и title (например, [{"id": "v1", "title": "Default", "price": 19.99}]). additional_fields: Необязательный словарь дополнительных документированных полей (например, handle, url, description, type, vendor, image_url, images), объединяемых с телом запроса. Returns: JSON с созданным объектом товара.

Параметры

  • store_idstringобязательный
  • product_idstringобязательный
  • titlestringобязательный
  • variantsarrayобязательный
  • additional_fieldsany
  • accountany
create_store_product_image

Добавляет изображение к товару в магазине электронной коммерции. image_id предоставляется клиентом и должен быть уникальным в пределах товара; url должен указывать на общедоступное изображение. Инструмент ручного управления подходит для кастомных/бесхедовых магазинов; интеграции с Shopify и WooCommerce синхронизируют изображения товаров автоматически. Аргументы: store_id: Идентификатор магазина электронной коммерции. Получите из list_ecommerce_stores. product_id: Идентификатор товара для прикрепления изображения. image_id: Уникальный идентификатор нового изображения, предоставляемый клиентом (например, 'img_1'). url: Общедоступный URL изображения. additional_fields: Необязательный словарь дополнительных полей изображения, объединяемых в тело (например, variant_ids). Возвращает: JSON с созданным объектом изображения.

Добавляет изображение к товару в магазине электронной коммерции. image_id предоставляется клиентом и должен быть уникальным в пределах товара; url должен указывать на общедоступное изображение. Инструмент ручного управления подходит для кастомных/бесхедовых магазинов; интеграции с Shopify и WooCommerce синхронизируют изображения товаров автоматически. Аргументы: store_id: Идентификатор магазина электронной коммерции. Получите из list_ecommerce_stores. product_id: Идентификатор товара для прикрепления изображения. image_id: Уникальный идентификатор нового изображения, предоставляемый клиентом (например, 'img_1'). url: Общедоступный URL изображения. additional_fields: Необязательный словарь дополнительных полей изображения, объединяемых в тело (например, variant_ids). Возвращает: JSON с созданным объектом изображения.

Параметры

  • store_idstringобязательный
  • product_idstringобязательный
  • image_idstringобязательный
  • urlstringобязательный
  • additional_fieldsany
  • accountany
create_store_product_variant

Добавляет новый вариант к существующему товару в магазине. Используется для представления отдельного SKU, размера или цвета товара. Многие магазины синхронизируют варианты автоматически через интеграции с Shopify или WooCommerce; ручное создание подходит для кастомных или headless витрин. Аргументы: store_id: Идентификатор магазина (E-commerce store ID). product_id: Идентификатор товара, к которому добавляется вариант. variant_id: Уникальный ID нового варианта, предоставленный клиентом. title: Название варианта (например, 'Large / Blue'). additional_fields: Необязательный словарь дополнительных документированных полей (например, url, sku, price, inventory_quantity, image_url), которые добавляются в тело запроса. Возвращает: JSON с созданным объектом варианта.

Добавляет новый вариант к существующему товару в магазине. Используется для представления отдельного SKU, размера или цвета товара. Многие магазины синхронизируют варианты автоматически через интеграции с Shopify или WooCommerce; ручное создание подходит для кастомных или headless витрин. Аргументы: store_id: Идентификатор магазина (E-commerce store ID). product_id: Идентификатор товара, к которому добавляется вариант. variant_id: Уникальный ID нового варианта, предоставленный клиентом. title: Название варианта (например, 'Large / Blue'). additional_fields: Необязательный словарь дополнительных документированных полей (например, url, sku, price, inventory_quantity, image_url), которые добавляются в тело запроса. Возвращает: JSON с созданным объектом варианта.

Параметры

  • store_idstringобязательный
  • product_idstringобязательный
  • variant_idstringобязательный
  • titlestringобязательный
  • additional_fieldsany
  • accountany
create_template

Создаёт новый переиспользуемый шаблон email из HTML-кода. Используйте, чтобы сохранить HTML-дизайны писем для повторного использования в кампаниях. HTML шаблона можно получить позже через get_template_default_content и передать в set_campaign_content. Чтобы просмотреть существующие шаблоны, используйте list_templates. Не используйте для разовых писем — в таких случаях сразу вызывайте set_campaign_content. Аргументы: name: Отображаемое имя шаблона (например, 'Monthly Newsletter v2'). html: Полный HTML-код. Должен быть валидным HTML со встроенными CSS для совместимости с почтовыми клиентами. Поддерживаются теги слияния Mailchimp (например, *|FNAME|*, *|UNSUB|*). folder_id: ID папки шаблона (необязательно) для организации. Получить можно в веб-интерфейсе Mailchimp. Возвращает: JSON с полями id (int, ID нового шаблона), name, type ('user'), active (boolean), date_created.

Создаёт новый переиспользуемый шаблон email из HTML-кода. Используйте, чтобы сохранить HTML-дизайны писем для повторного использования в кампаниях. HTML шаблона можно получить позже через get_template_default_content и передать в set_campaign_content. Чтобы просмотреть существующие шаблоны, используйте list_templates. Не используйте для разовых писем — в таких случаях сразу вызывайте set_campaign_content. Аргументы: name: Отображаемое имя шаблона (например, 'Monthly Newsletter v2'). html: Полный HTML-код. Должен быть валидным HTML со встроенными CSS для совместимости с почтовыми клиентами. Поддерживаются теги слияния Mailchimp (например, *|FNAME|*, *|UNSUB|*). folder_id: ID папки шаблона (необязательно) для организации. Получить можно в веб-интерфейсе Mailchimp. Возвращает: JSON с полями id (int, ID нового шаблона), name, type ('user'), active (boolean), date_created.

Параметры

  • namestringобязательный
  • htmlstringобязательный
  • folder_idany
  • accountany
create_template_folder

Создаёт новую папку для организации шаблонов. Используйте для группировки связанных шаблонов и упрощения навигации. Назначайте шаблоны в папку через поле folder_id при их создании. Применяйте list_template_folders для просмотра существующих папок. Аргументы: name: Отображаемое имя новой папки (например, 'Promotional Templates'). Возвращает: JSON с id (идентификатор новой папки), name и количеством шаблонов в папке.

Создаёт новую папку для организации шаблонов. Используйте для группировки связанных шаблонов и упрощения навигации. Назначайте шаблоны в папку через поле folder_id при их создании. Применяйте list_template_folders для просмотра существующих папок. Аргументы: name: Отображаемое имя новой папки (например, 'Promotional Templates'). Возвращает: JSON с id (идентификатор новой папки), name и количеством шаблонов в папке.

Параметры

  • namestringобязательный
  • accountany
create_verified_domain

Начните верификацию домена, отправив код подтверждения на адрес в этом домене. Домен определяется как часть verification_email после '@'. Mailchimp отправляет код на этот адрес; передайте его в verify_verified_domain, чтобы завершить верификацию. Перед началом проверьте уже верифицированные домены через list_verified_domains. Аргументы: verification_email: Почтовый ящик на проверяемом домене (например, 'admin@mail.example.com'). Сюда будет отправлен код подтверждения. Возвращает: JSON с полями domain, verified (логическое), authenticated (логическое), verification_status, authentication_status.

Начните верификацию домена, отправив код подтверждения на адрес в этом домене. Домен определяется как часть verification_email после '@'. Mailchimp отправляет код на этот адрес; передайте его в verify_verified_domain, чтобы завершить верификацию. Перед началом проверьте уже верифицированные домены через list_verified_domains. Аргументы: verification_email: Почтовый ящик на проверяемом домене (например, 'admin@mail.example.com'). Сюда будет отправлен код подтверждения. Возвращает: JSON с полями domain, verified (логическое), authenticated (логическое), verification_status, authentication_status.

Параметры

  • verification_emailstringобязательный
  • accountany
create_webhook

Создайте вебхук, который отправляет HTTP POST-уведомления на внешний URL при событиях аудитории. Побочный эффект: Mailchimp отправляет проверочный GET-запрос при создании; URL должен быть общедоступным и возвращать HTTP 200. Все события и источники включены по умолчанию, если не указаны. Не используйте для опроса или пакетного получения данных; вместо этого используйте list_audience_members или отчёты кампаний. Аргументы: list_id — идентификатор аудитории/списка (10 символов, буквы и цифры, например 'abc123def4'). Получите из list_audiences. url — публичный HTTPS-URL для приёма POST-запросов. Должен возвращать HTTP 200 при проверочном GET-запросе. events — события через запятую: 'subscribe', 'unsubscribe', 'profile', 'cleaned', 'upemail', 'campaign'. Если не указаны, включены все. sources — источники через запятую: 'user', 'admin', 'api'. Если не указаны, включены все. Возвращает: JSON с полями id, url, events (логические флаги), sources (логические флаги). Ошибка, если проверка URL не прошла.

Создайте вебхук, который отправляет HTTP POST-уведомления на внешний URL при событиях аудитории. Побочный эффект: Mailchimp отправляет проверочный GET-запрос при создании; URL должен быть общедоступным и возвращать HTTP 200. Все события и источники включены по умолчанию, если не указаны. Не используйте для опроса или пакетного получения данных; вместо этого используйте list_audience_members или отчёты кампаний. Аргументы: list_id — идентификатор аудитории/списка (10 символов, буквы и цифры, например 'abc123def4'). Получите из list_audiences. url — публичный HTTPS-URL для приёма POST-запросов. Должен возвращать HTTP 200 при проверочном GET-запросе. events — события через запятую: 'subscribe', 'unsubscribe', 'profile', 'cleaned', 'upemail', 'campaign'. Если не указаны, включены все. sources — источники через запятую: 'user', 'admin', 'api'. Если не указаны, включены все. Возвращает: JSON с полями id, url, events (логические флаги), sources (логические флаги). Ошибка, если проверка URL не прошла.

Параметры

  • list_idstringобязательный
  • urlstringобязательный
  • eventsany
  • sourcesany
  • accountany
customize_signup_form

Настраивает стандартную форму регистрации для аудитории (заголовок, блоки контента и стили). Нужно указать хотя бы один из параметров: header, contents или styles. Сначала используйте list_signup_forms, чтобы посмотреть текущую форму и повторить её структуру. Аргументы: list_id: ID аудитории/списка (из list_audiences). header: Необязательный объект заголовка, например {"image_url": "...", "text": "...", "background_color": "..."}. contents: Необязательный массив блоков контента, каждый {"section": <name>, "value": <html>}. Имена секций: 'signup_message', 'unsub_message', 'signup_thank_you_title'. styles: Необязательный массив секций стилей, каждая {"section": <name>, "options": [{"property": <name>, "value": <val>}]}. Возвращает: JSON с обновлённой конфигурацией формы регистрации или объект ошибки.

Настраивает стандартную форму регистрации для аудитории (заголовок, блоки контента и стили). Нужно указать хотя бы один из параметров: header, contents или styles. Сначала используйте list_signup_forms, чтобы посмотреть текущую форму и повторить её структуру. Аргументы: list_id: ID аудитории/списка (из list_audiences). header: Необязательный объект заголовка, например {"image_url": "...", "text": "...", "background_color": "..."}. contents: Необязательный массив блоков контента, каждый {"section": <name>, "value": <html>}. Имена секций: 'signup_message', 'unsub_message', 'signup_thank_you_title'. styles: Необязательный массив секций стилей, каждая {"section": <name>, "options": [{"property": <name>, "value": <val>}]}. Возвращает: JSON с обновлённой конфигурацией формы регистрации или объект ошибки.

Параметры

  • list_idstringобязательный
  • headerany
  • contentsany
  • stylesany
  • accountany
delete_audienceидемпотентный

Навсегда удаляет аудиторию и всех её участников, сегменты, кампании и статистику. Необратимо. Побочный эффект: удаляет каждого участника аудитории и все связанные с ней исторические данные. Отменить через API невозможно. Вместо этого используйте update_audience для переименования или изменений вроде архивации. При необходимости сначала сделайте резервную копию участников с помощью list_audience_members. Возвращает ошибку 404, если list_id не существует. Аргументы: list_id: идентификатор аудитории/списка для удаления (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. Перепроверьте перед вызовом — удаление необратимо. Возвращает: JSON с полем status ('deleted') и list_id при успехе или объект ошибки при неудаче.

Навсегда удаляет аудиторию и всех её участников, сегменты, кампании и статистику. Необратимо. Побочный эффект: удаляет каждого участника аудитории и все связанные с ней исторические данные. Отменить через API невозможно. Вместо этого используйте update_audience для переименования или изменений вроде архивации. При необходимости сначала сделайте резервную копию участников с помощью list_audience_members. Возвращает ошибку 404, если list_id не существует. Аргументы: list_id: идентификатор аудитории/списка для удаления (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. Перепроверьте перед вызовом — удаление необратимо. Возвращает: JSON с полем status ('deleted') и list_id при успехе или объект ошибки при неудаче.

Параметры

  • list_idstringобязательный
  • accountany
delete_batch_webhookидемпотентный

Delete a batch webhook permanently. Irreversible. Mailchimp will stop sending batch-completion callbacks to the webhook's URL. Use list_batch_webhooks to find batch_webhook_id values. Returns 404 error if batch_webhook_id is invalid. Args: batch_webhook_id: The batch webhook ID to delete. Obtain from list_batch_webhooks. Returns: JSON confirming the deletion, or an error object if batch_webhook_id is invalid. On success the Mailchimp API returns an empty body (HTTP 204).

Delete a batch webhook permanently. Irreversible. Mailchimp will stop sending batch-completion callbacks to the webhook's URL. Use list_batch_webhooks to find batch_webhook_id values. Returns 404 error if batch_webhook_id is invalid. Args: batch_webhook_id: The batch webhook ID to delete. Obtain from list_batch_webhooks. Returns: JSON confirming the deletion, or an error object if batch_webhook_id is invalid. On success the Mailchimp API returns an empty body (HTTP 204).

Параметры

  • batch_webhook_idstringобязательный
  • accountany
delete_campaignидемпотентный

Окончательно удалить кампанию из аккаунта. Используйте для удаления нежелательных черновиков или запланированных кампаний. Работает только с кампаниями, которые ещё не отправлены (статус 'save' или 'schedule'). Отправленные кампании удалить нельзя — вернётся ошибка. Если хотите сохранить настройки, перед удалением склонируйте кампанию через replicate_campaign. Args: campaign_id: ID кампании для удаления (например 'abc123def4'). Не должна быть отправленной кампанией. Returns: JSON с полями: status ("deleted"), campaign_id. Возвращает ошибку, если кампания уже отправлена. Пример: delete_campaign(campaign_id="abc123") -> {"status": "deleted", "campaign_id": "abc123"}

Окончательно удалить кампанию из аккаунта. Используйте для удаления нежелательных черновиков или запланированных кампаний. Работает только с кампаниями, которые ещё не отправлены (статус 'save' или 'schedule'). Отправленные кампании удалить нельзя — вернётся ошибка. Если хотите сохранить настройки, перед удалением склонируйте кампанию через replicate_campaign. Args: campaign_id: ID кампании для удаления (например 'abc123def4'). Не должна быть отправленной кампанией. Returns: JSON с полями: status ("deleted"), campaign_id. Возвращает ошибку, если кампания уже отправлена. Пример: delete_campaign(campaign_id="abc123") -> {"status": "deleted", "campaign_id": "abc123"}

Параметры

  • campaign_idstringобязательный
  • accountany
delete_campaign_feedbackидемпотентный

Окончательно удаляет комментарий к обратной связи кампании. НЕОБРАТИМО. Используйте, чтобы убрать устаревшую заметку о коллаборации. Примените list_campaign_feedback, чтобы узнать ID комментариев. Args: campaign_id: ID кампании, к которой относится комментарий. Получите из list_campaigns. feedback_id: ID комментария для удаления. Получите из list_campaign_feedback. Returns: JSON с полями status ("deleted"), campaign_id, feedback_id.

Окончательно удаляет комментарий к обратной связи кампании. НЕОБРАТИМО. Используйте, чтобы убрать устаревшую заметку о коллаборации. Примените list_campaign_feedback, чтобы узнать ID комментариев. Args: campaign_id: ID кампании, к которой относится комментарий. Получите из list_campaigns. feedback_id: ID комментария для удаления. Получите из list_campaign_feedback. Returns: JSON с полями status ("deleted"), campaign_id, feedback_id.

Параметры

  • campaign_idstringобязательный
  • feedback_idstringобязательный
  • accountany
delete_campaign_folderидемпотентный

Удалить папку с кампаниями навсегда. Необратимо. Удаление папки не удаляет кампании внутри неё — они становятся нераспределёнными. Используйте list_campaign_folders, чтобы узнать ID папок. Аргументы: folder_id: ID папки кампании для удаления. Получить из list_campaign_folders. Возвращает: JSON со статусом ("deleted") и folder_id.

Удалить папку с кампаниями навсегда. Необратимо. Удаление папки не удаляет кампании внутри неё — они становятся нераспределёнными. Используйте list_campaign_folders, чтобы узнать ID папок. Аргументы: folder_id: ID папки кампании для удаления. Получить из list_campaign_folders. Возвращает: JSON со статусом ("deleted") и folder_id.

Параметры

  • folder_idstringобязательный
  • accountany
delete_connected_siteидемпотентный

Удалить подключённый сайт из аккаунта навсегда. Необратимо. После удаления отслеживание и всплывающие формы, привязанные к этому сайту, перестают работать. Сначала используйте list_connected_sites, чтобы найти идентификаторы подключённых сайтов. Аргументы: connected_site_id: Идентификатор подключённого сайта для удаления. Получить из list_connected_sites. Возвращает: JSON со статусом ("deleted") и connected_site_id.

Удалить подключённый сайт из аккаунта навсегда. Необратимо. После удаления отслеживание и всплывающие формы, привязанные к этому сайту, перестают работать. Сначала используйте list_connected_sites, чтобы найти идентификаторы подключённых сайтов. Аргументы: connected_site_id: Идентификатор подключённого сайта для удаления. Получить из list_connected_sites. Возвращает: JSON со статусом ("deleted") и connected_site_id.

Параметры

  • connected_site_idstringобязательный
  • accountany
delete_fileидемпотентный

Удаляет файл из File Manager без возможности восстановления. Необратимо. Любая кампания или шаблон, которые ссылаются на URL размещённого файла, после удаления будут показывать битое изображение. Используйте list_files, чтобы найти file_id, и get_file, чтобы убедиться, что цель верна, перед удалением. Аргументы: file_id: ID файла (числовой, в виде строки) из list_files. Возвращает: JSON со статусом 'success' при удалении или объект ошибки, если file_id недействителен.

Удаляет файл из File Manager без возможности восстановления. Необратимо. Любая кампания или шаблон, которые ссылаются на URL размещённого файла, после удаления будут показывать битое изображение. Используйте list_files, чтобы найти file_id, и get_file, чтобы убедиться, что цель верна, перед удалением. Аргументы: file_id: ID файла (числовой, в виде строки) из list_files. Возвращает: JSON со статусом 'success' при удалении или объект ошибки, если file_id недействителен.

Параметры

  • file_idstringобязательный
  • accountany
delete_interestидемпотентный

Удаляет один вариант интереса из категории, сохраняя категорию и остальные варианты. Используйте, чтобы удалить один конкретный вариант. Интерес и его подписки удаляются. Вместо этого используйте delete_interest_category, чтобы удалить всю категорию со всеми вариантами разом. Аргументы: list_id: ID аудитории/списка Mailchimp (например, 'abc123def4'). Получите из list_audiences. category_id: ID категории интересов. Получите из list_interest_categories. interest_id: ID удаляемого варианта интереса. Получите из list_interests. Возвращает: JSON с полями: status ("deleted"), interest_id. Возвращает ошибку, если интереса не существует. Пример: delete_interest(list_id="abc123", category_id="cat456", interest_id="int789") -> {"status": "deleted", "interest_id": "int789"}

Удаляет один вариант интереса из категории, сохраняя категорию и остальные варианты. Используйте, чтобы удалить один конкретный вариант. Интерес и его подписки удаляются. Вместо этого используйте delete_interest_category, чтобы удалить всю категорию со всеми вариантами разом. Аргументы: list_id: ID аудитории/списка Mailchimp (например, 'abc123def4'). Получите из list_audiences. category_id: ID категории интересов. Получите из list_interest_categories. interest_id: ID удаляемого варианта интереса. Получите из list_interests. Возвращает: JSON с полями: status ("deleted"), interest_id. Возвращает ошибку, если интереса не существует. Пример: delete_interest(list_id="abc123", category_id="cat456", interest_id="int789") -> {"status": "deleted", "interest_id": "int789"}

Параметры

  • list_idstringобязательный
  • category_idstringобязательный
  • interest_idstringобязательный
  • accountany
delete_interest_categoryидемпотентный

Удаляет категорию интересов и все её варианты разом. Убирает всю категорию со всеми её вариантами. Все связи подписчиков с интересами из этой категории удаляются. Сами подписчики не затрагиваются. Используйте `delete_interest`, если нужно удалить один вариант, сохранив категорию. Используйте `list_interest_categories`, чтобы найти идентификаторы категорий. Аргументы: - `list_id` — идентификатор аудитории/списка Mailchimp (например, `'abc123def4'`). Получите из `list_audiences`. - `category_id` — идентификатор удаляемой категории интересов. Получите из `list_interest_categories`. Возвращает: - JSON с полями: `status` (`"deleted"`), `category_id`. Возвращает ошибку, если категория не существует. Пример: ```python delete_interest_category(list_id="abc123", category_id="cat456") -> {"status": "deleted", "category_id": "cat456"} ```

Удаляет категорию интересов и все её варианты разом. Убирает всю категорию со всеми её вариантами. Все связи подписчиков с интересами из этой категории удаляются. Сами подписчики не затрагиваются. Используйте `delete_interest`, если нужно удалить один вариант, сохранив категорию. Используйте `list_interest_categories`, чтобы найти идентификаторы категорий. Аргументы: - `list_id` — идентификатор аудитории/списка Mailchimp (например, `'abc123def4'`). Получите из `list_audiences`. - `category_id` — идентификатор удаляемой категории интересов. Получите из `list_interest_categories`. Возвращает: - JSON с полями: `status` (`"deleted"`), `category_id`. Возвращает ошибку, если категория не существует. Пример: ```python delete_interest_category(list_id="abc123", category_id="cat456") -> {"status": "deleted", "category_id": "cat456"} ```

Параметры

  • list_idstringобязательный
  • category_idstringобязательный
  • accountany
delete_landing_pageидемпотентный

Удалить целевую страницу навсегда. Отменить это действие невозможно. Побочный эффект: страница сразу становится недоступной по её публичному URL. Данные о прошлых посещениях остаются в отчётах Mailchimp, но сама страница удаляется. Используйте unpublish_landing_page, если нужно временно отключить страницу. Возвращает ошибку 404, если page_id недействителен. Параметры: page_id: ID целевой страницы для удаления. Получить из list_landing_pages. Возвращает: JSON со статусом ('deleted') и page_id в случае успеха.

Удалить целевую страницу навсегда. Отменить это действие невозможно. Побочный эффект: страница сразу становится недоступной по её публичному URL. Данные о прошлых посещениях остаются в отчётах Mailchimp, но сама страница удаляется. Используйте unpublish_landing_page, если нужно временно отключить страницу. Возвращает ошибку 404, если page_id недействителен. Параметры: page_id: ID целевой страницы для удаления. Получить из list_landing_pages. Возвращает: JSON со статусом ('deleted') и page_id в случае успеха.

Параметры

  • page_idstringобязательный
  • accountany
delete_memberидемпотентный

Навсегда удаляет участника и все его данные из аудитории. Используйте только для полного удаления данных (например, по запросу на удаление согласно GDPR). Вся история действий, данные объединённых полей и привязки тегов теряются безвозвратно. По функционалу эквивалентно delete_member_permanent (тот же endpoint). Чтобы прекратить отправку, но сохранить данные для отчётов, используйте unsubscribe_member. Отменить нельзя. Аргументы: list_id: ID аудитории/списка Mailchimp (например, 'abc123def4'). Получить из list_audiences. email_address: Email-адрес участника, которого нужно удалить навсегда. Должен существовать в аудитории. Возвращает: JSON с полями: status ("permanently_deleted"), email_address. Возвращает ошибку, если участник не существует. Пример: delete_member(list_id="abc123", email_address="jane@co.com") -> {"status": "permanently_deleted", "email_address": "jane@co.com"}

Навсегда удаляет участника и все его данные из аудитории. Используйте только для полного удаления данных (например, по запросу на удаление согласно GDPR). Вся история действий, данные объединённых полей и привязки тегов теряются безвозвратно. По функционалу эквивалентно delete_member_permanent (тот же endpoint). Чтобы прекратить отправку, но сохранить данные для отчётов, используйте unsubscribe_member. Отменить нельзя. Аргументы: list_id: ID аудитории/списка Mailchimp (например, 'abc123def4'). Получить из list_audiences. email_address: Email-адрес участника, которого нужно удалить навсегда. Должен существовать в аудитории. Возвращает: JSON с полями: status ("permanently_deleted"), email_address. Возвращает ошибку, если участник не существует. Пример: delete_member(list_id="abc123", email_address="jane@co.com") -> {"status": "permanently_deleted", "email_address": "jane@co.com"}

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • accountany
delete_member_noteидемпотентный

Навсегда удаляет заметку, прикреплённую к участнику. Отменить нельзя. Перед вызовом используйте list_member_notes, чтобы найти note_ids. Не влияет на самого участника, только на заметку. Возвращает 404, если заметка или участник не существует. Параметры: list_id: Идентификатор списка/аудитории. Получить из list_audiences. email_address: Email участника, которому принадлежит заметка. note_id: Идентификатор заметки для удаления. Получить из list_member_notes. Возвращает: JSON с полями status ('deleted'), email_address, note_id при успехе.

Навсегда удаляет заметку, прикреплённую к участнику. Отменить нельзя. Перед вызовом используйте list_member_notes, чтобы найти note_ids. Не влияет на самого участника, только на заметку. Возвращает 404, если заметка или участник не существует. Параметры: list_id: Идентификатор списка/аудитории. Получить из list_audiences. email_address: Email участника, которому принадлежит заметка. note_id: Идентификатор заметки для удаления. Получить из list_member_notes. Возвращает: JSON с полями status ('deleted'), email_address, note_id при успехе.

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • note_idstringобязательный
  • accountany
delete_member_permanentидемпотентный

Безвозвратно и окончательно удаляет участника аудитории (удаление по стандарту GDPR). НЕОБРАТИМО: это навсегда стирает все персональные данные участника и блокирует возможность повторного импорта этого email в аудиторию. Этот инструмент и delete_member эквивалентны – оба вызывают один и тот же endpoint полного удаления. Если нужно просто отключить рассылку, но сохранить участника для отчётов, используйте unsubscribe_member. Аргументы: list_id: Идентификатор аудитории/списка (10-символьный буквенно-цифровой код, например 'abc123def4'). Получить из list_audiences. email_address: Email-адрес участника. Хеш подписчика вычисляется автоматически. Возвращает: JSON с подтверждением полного удаления или объект ошибки, если участник не найден. При успехе Mailchimp API возвращает пустое тело ответа (HTTP 204).

Безвозвратно и окончательно удаляет участника аудитории (удаление по стандарту GDPR). НЕОБРАТИМО: это навсегда стирает все персональные данные участника и блокирует возможность повторного импорта этого email в аудиторию. Этот инструмент и delete_member эквивалентны – оба вызывают один и тот же endpoint полного удаления. Если нужно просто отключить рассылку, но сохранить участника для отчётов, используйте unsubscribe_member. Аргументы: list_id: Идентификатор аудитории/списка (10-символьный буквенно-цифровой код, например 'abc123def4'). Получить из list_audiences. email_address: Email-адрес участника. Хеш подписчика вычисляется автоматически. Возвращает: JSON с подтверждением полного удаления или объект ошибки, если участник не найден. При успехе Mailchimp API возвращает пустое тело ответа (HTTP 204).

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • accountany
delete_merge_fieldидемпотентный

Удаляет пользовательское поле слияния и все его сохранённые данные из аудитории. Используйте только когда поле больше не нужно. Все данные, хранящиеся в этом поле для каждого участника, теряются навсегда. Стандартные поля (FNAME, LNAME, ADDRESS, PHONE) удалить нельзя — они вернут ошибку. Используйте list_merge_fields, чтобы найти значения merge_id. Аргументы: list_id: ID аудитории/списка Mailchimp (например 'abc123def4'). Узнаётся через list_audiences. merge_id: ID поля слияния для удаления (числовая строка). Узнаётся через list_merge_fields. Не может быть стандартным полем. Возвращает: JSON с полями: status ("deleted"), merge_id. Возвращает ошибку, если поле стандартное или не существует. Пример: delete_merge_field(list_id="abc123", merge_id="5") -> {"status": "deleted", "merge_id": "5"}

Удаляет пользовательское поле слияния и все его сохранённые данные из аудитории. Используйте только когда поле больше не нужно. Все данные, хранящиеся в этом поле для каждого участника, теряются навсегда. Стандартные поля (FNAME, LNAME, ADDRESS, PHONE) удалить нельзя — они вернут ошибку. Используйте list_merge_fields, чтобы найти значения merge_id. Аргументы: list_id: ID аудитории/списка Mailchimp (например 'abc123def4'). Узнаётся через list_audiences. merge_id: ID поля слияния для удаления (числовая строка). Узнаётся через list_merge_fields. Не может быть стандартным полем. Возвращает: JSON с полями: status ("deleted"), merge_id. Возвращает ошибку, если поле стандартное или не существует. Пример: delete_merge_field(list_id="abc123", merge_id="5") -> {"status": "deleted", "merge_id": "5"}

Параметры

  • list_idstringобязательный
  • merge_idstringобязательный
  • accountany
delete_promo_codeидемпотентный

Навсегда удаляет промокод. История предыдущих использований теряется. Безвозвратно. Используйте update_promo_code с параметром enabled=false, чтобы отключить код, сохранив статистику его активаций. Используйте delete_promo_rule, чтобы удалить правило и все связанные с ним коды за раз. Возвращает 404, если хотя бы один из параметров store_id, promo_rule_id или promo_code_id недействителен. Аргументы: store_id: ID магазина электронной коммерции. promo_rule_id: ID правила, к которому привязан код. promo_code_id: ID кода для удаления. Результат: JSON с полями статус ('deleted'), store_id, promo_rule_id, promo_code_id в случае успеха.

Навсегда удаляет промокод. История предыдущих использований теряется. Безвозвратно. Используйте update_promo_code с параметром enabled=false, чтобы отключить код, сохранив статистику его активаций. Используйте delete_promo_rule, чтобы удалить правило и все связанные с ним коды за раз. Возвращает 404, если хотя бы один из параметров store_id, promo_rule_id или promo_code_id недействителен. Аргументы: store_id: ID магазина электронной коммерции. promo_rule_id: ID правила, к которому привязан код. promo_code_id: ID кода для удаления. Результат: JSON с полями статус ('deleted'), store_id, promo_rule_id, promo_code_id в случае успеха.

Параметры

  • store_idstringобязательный
  • promo_rule_idstringобязательный
  • promo_code_idstringобязательный
  • accountany
delete_promo_ruleидемпотентный

Окончательно удаляет промо-правило и все связанные с ним промокоды. Отменить нельзя. Побочный эффект: каждый промокод, привязанный к этому правилу, тоже удаляется и перестаёт работать на checkout. Используйте update_promo_rule с enabled=false, чтобы отключить правило без удаления его кодов. Возвращает 404, если store_id или promo_rule_id некорректны. Аргументы: store_id: ID магазина электронной коммерции. promo_rule_id: ID правила, которое нужно удалить. Возвращает: JSON со статусом ('deleted'), store_id, promo_rule_id в случае успеха.

Окончательно удаляет промо-правило и все связанные с ним промокоды. Отменить нельзя. Побочный эффект: каждый промокод, привязанный к этому правилу, тоже удаляется и перестаёт работать на checkout. Используйте update_promo_rule с enabled=false, чтобы отключить правило без удаления его кодов. Возвращает 404, если store_id или promo_rule_id некорректны. Аргументы: store_id: ID магазина электронной коммерции. promo_rule_id: ID правила, которое нужно удалить. Возвращает: JSON со статусом ('deleted'), store_id, promo_rule_id в случае успеха.

Параметры

  • store_idstringобязательный
  • promo_rule_idstringобязательный
  • accountany
delete_segmentидемпотентный

Удаляет сегмент или тег из аудитории. Участники остаются в аудитории. Необратимо. Используйте update_segment, чтобы переименовать или изменить условия вместо удаления. Используйте list_segments, чтобы найти ID сегментов. Возвращает ошибку 404, если сегмент не существует. Аргументы: list_id: ID аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. segment_id: ID удаляемого сегмента/тега (числовая строка, например '12345'). Получить из list_segments. Возвращает: JSON со статусом ("deleted"), segment_id.

Удаляет сегмент или тег из аудитории. Участники остаются в аудитории. Необратимо. Используйте update_segment, чтобы переименовать или изменить условия вместо удаления. Используйте list_segments, чтобы найти ID сегментов. Возвращает ошибку 404, если сегмент не существует. Аргументы: list_id: ID аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. segment_id: ID удаляемого сегмента/тега (числовая строка, например '12345'). Получить из list_segments. Возвращает: JSON со статусом ("deleted"), segment_id.

Параметры

  • list_idstringобязательный
  • segment_idstringобязательный
  • accountany
delete_storeидемпотентный

Удаляет магазин электронной коммерции из Mailchimp без возможности восстановления. Это каскадное удаление: вместе с магазином удаляются все его товары, варианты, клиенты, корзины и заказы. Действие необратимо. Перед вызовом внимательно проверьте store_id. Args: store_id: Идентификатор магазина электронной коммерции для удаления. Returns: JSON с подтверждением удаления (пустое тело при успехе).

Удаляет магазин электронной коммерции из Mailchimp без возможности восстановления. Это каскадное удаление: вместе с магазином удаляются все его товары, варианты, клиенты, корзины и заказы. Действие необратимо. Перед вызовом внимательно проверьте store_id. Args: store_id: Идентификатор магазина электронной коммерции для удаления. Returns: JSON с подтверждением удаления (пустое тело при успехе).

Параметры

  • store_idstringобязательный
  • accountany
delete_store_cartидемпотентный

Навсегда удаляет корзину из магазина. Отменить нельзя. Используйте, когда внешняя система сообщает, что корзина завершена (преобразована в заказ) или истекла. Не влияет на связанные заказы или записи клиентов. Возвращает 404, если store_id или cart_id недействительны. Аргументы: store_id: ID магазина электронной коммерции. cart_id: ID корзины для удаления. Возвращает: JSON со статусом ('deleted'), store_id, cart_id при успехе.

Навсегда удаляет корзину из магазина. Отменить нельзя. Используйте, когда внешняя система сообщает, что корзина завершена (преобразована в заказ) или истекла. Не влияет на связанные заказы или записи клиентов. Возвращает 404, если store_id или cart_id недействительны. Аргументы: store_id: ID магазина электронной коммерции. cart_id: ID корзины для удаления. Возвращает: JSON со статусом ('deleted'), store_id, cart_id при успехе.

Параметры

  • store_idstringобязательный
  • cart_idstringобязательный
  • accountany
delete_store_customerидемпотентный

Окончательно удаляет покупателя из магазина. Это действие нельзя отменить: оно разрывает связь покупателя с данными о покупках в магазине. При этом покупатель не удаляется из подключённой аудитории. Аргументы: store_id: идентификатор магазина электронной коммерции. customer_id: идентификатор удаляемого покупателя. Возвращает: JSON с подтверждением удаления (пустое тело при успехе).

Окончательно удаляет покупателя из магазина. Это действие нельзя отменить: оно разрывает связь покупателя с данными о покупках в магазине. При этом покупатель не удаляется из подключённой аудитории. Аргументы: store_id: идентификатор магазина электронной коммерции. customer_id: идентификатор удаляемого покупателя. Возвращает: JSON с подтверждением удаления (пустое тело при успехе).

Параметры

  • store_idstringобязательный
  • customer_idstringобязательный
  • accountany
delete_store_orderидемпотентный

Окончательно удаляет заказ электронной коммерции из магазина. Это удаляет заказ и его строки, и это действие нельзя отменить. Ручная коммерция подходит для кастомных/headless магазинов; интеграции Shopify и WooCommerce синхронизируют заказы автоматически. Аргументы: store_id: Идентификатор магазина электронной коммерции. Получить из list_ecommerce_stores. order_id: Идентификатор заказа для удаления. Возвращает: JSON, подтверждающий удаление (пустое тело при успехе) или объект ошибки.

Окончательно удаляет заказ электронной коммерции из магазина. Это удаляет заказ и его строки, и это действие нельзя отменить. Ручная коммерция подходит для кастомных/headless магазинов; интеграции Shopify и WooCommerce синхронизируют заказы автоматически. Аргументы: store_id: Идентификатор магазина электронной коммерции. Получить из list_ecommerce_stores. order_id: Идентификатор заказа для удаления. Возвращает: JSON, подтверждающий удаление (пустое тело при успехе) или объект ошибки.

Параметры

  • store_idstringобязательный
  • order_idstringобязательный
  • accountany
delete_store_order_lineидемпотентный

Окончательно удаляет позицию из заказа электронной коммерции. Это удаляет строку из заказа, и отменить действие нельзя. Ручная торговля подходит для кастомных/безголовых магазинов; интеграции с Shopify и WooCommerce синхронизируют строки заказов автоматически. Аргументы: store_id: Идентификатор магазина электронной коммерции. Получите из list_ecommerce_stores. order_id: Идентификатор заказа, которому принадлежит строка. line_id: Идентификатор позиции для удаления. Возвращает: JSON с подтверждением удаления (пустое тело при успехе) или объект ошибки.

Окончательно удаляет позицию из заказа электронной коммерции. Это удаляет строку из заказа, и отменить действие нельзя. Ручная торговля подходит для кастомных/безголовых магазинов; интеграции с Shopify и WooCommerce синхронизируют строки заказов автоматически. Аргументы: store_id: Идентификатор магазина электронной коммерции. Получите из list_ecommerce_stores. order_id: Идентификатор заказа, которому принадлежит строка. line_id: Идентификатор позиции для удаления. Возвращает: JSON с подтверждением удаления (пустое тело при успехе) или объект ошибки.

Параметры

  • store_idstringобязательный
  • order_idstringобязательный
  • line_idstringобязательный
  • accountany
delete_store_productидемпотентный

Удаляет товар и все его варианты из магазина навсегда. Это действие нельзя отменить, оно также удаляет варианты товара. Проверьте product_id перед вызовом. Аргументы: store_id: Идентификатор магазина электронной коммерции. product_id: Идентификатор товара для удаления. Возвращает: JSON, подтверждающий удаление (пустое тело при успехе).

Удаляет товар и все его варианты из магазина навсегда. Это действие нельзя отменить, оно также удаляет варианты товара. Проверьте product_id перед вызовом. Аргументы: store_id: Идентификатор магазина электронной коммерции. product_id: Идентификатор товара для удаления. Возвращает: JSON, подтверждающий удаление (пустое тело при успехе).

Параметры

  • store_idstringобязательный
  • product_idstringобязательный
  • accountany
delete_store_product_imageидемпотентный

Окончательно удаляет изображение из товара в магазине электронной коммерции. Это удаляет изображение, и отменить это нельзя. Ручная коммерция подходит для пользовательских/headless магазинов; интеграции Shopify и WooCommerce синхронизируют изображения товаров автоматически. Аргументы: store_id: Идентификатор магазина электронной коммерции. Получить из list_ecommerce_stores. product_id: Идентификатор товара, которому принадлежит изображение. image_id: Идентификатор удаляемого изображения. Возвращает: JSON, подтверждающий удаление (пустое тело при успехе) или объект ошибки.

Окончательно удаляет изображение из товара в магазине электронной коммерции. Это удаляет изображение, и отменить это нельзя. Ручная коммерция подходит для пользовательских/headless магазинов; интеграции Shopify и WooCommerce синхронизируют изображения товаров автоматически. Аргументы: store_id: Идентификатор магазина электронной коммерции. Получить из list_ecommerce_stores. product_id: Идентификатор товара, которому принадлежит изображение. image_id: Идентификатор удаляемого изображения. Возвращает: JSON, подтверждающий удаление (пустое тело при успехе) или объект ошибки.

Параметры

  • store_idstringобязательный
  • product_idstringобязательный
  • image_idstringобязательный
  • accountany
delete_store_product_variantидемпотентный

Удаляет навсегда один вариант из продукта в магазине. Это нельзя отменить. У продукта должен оставаться хотя бы один вариант, поэтому API может отклонить удаление последнего варианта. Аргументы: store_id: Идентификатор магазина электронной коммерции. product_id: Идентификатор продукта, которому принадлежит вариант. variant_id: Идентификатор удаляемого варианта. Возвращает: JSON с подтверждением удаления (пустое тело в случае успеха).

Удаляет навсегда один вариант из продукта в магазине. Это нельзя отменить. У продукта должен оставаться хотя бы один вариант, поэтому API может отклонить удаление последнего варианта. Аргументы: store_id: Идентификатор магазина электронной коммерции. product_id: Идентификатор продукта, которому принадлежит вариант. variant_id: Идентификатор удаляемого варианта. Возвращает: JSON с подтверждением удаления (пустое тело в случае успеха).

Параметры

  • store_idstringобязательный
  • product_idstringобязательный
  • variant_idstringобязательный
  • accountany
delete_templateидемпотентный

Удаляет пользовательский шаблон без возможности восстановления. Операция необратима. Работает только с пользовательскими шаблонами; шаблоны из галереи и базовые шаблоны удалить нельзя. Не влияет на кампании, которые уже используют содержимое этого шаблона. Используйте list_templates, чтобы найти ID шаблонов. Возвращает ошибку 404, если template_id недействителен или не является пользовательским шаблоном. Аргументы: template_id — ID шаблона для удаления (числовая строка, например '12345'). Должен иметь тип 'user'. Возвращает: JSON с полями status ("deleted"), template_id.

Удаляет пользовательский шаблон без возможности восстановления. Операция необратима. Работает только с пользовательскими шаблонами; шаблоны из галереи и базовые шаблоны удалить нельзя. Не влияет на кампании, которые уже используют содержимое этого шаблона. Используйте list_templates, чтобы найти ID шаблонов. Возвращает ошибку 404, если template_id недействителен или не является пользовательским шаблоном. Аргументы: template_id — ID шаблона для удаления (числовая строка, например '12345'). Должен иметь тип 'user'. Возвращает: JSON с полями status ("deleted"), template_id.

Параметры

  • template_idstringобязательный
  • accountany
delete_template_folderидемпотентный

Удалить папку шаблонов навсегда. Необратимо. Удаление папки не удаляет шаблоны внутри неё; они становятся нераспределёнными. Используйте list_template_folders, чтобы узнать ID папок. Аргументы: folder_id: ID папки шаблонов для удаления. Получить из list_template_folders. Возвращает: JSON со статусом ("deleted") и folder_id.

Удалить папку шаблонов навсегда. Необратимо. Удаление папки не удаляет шаблоны внутри неё; они становятся нераспределёнными. Используйте list_template_folders, чтобы узнать ID папок. Аргументы: folder_id: ID папки шаблонов для удаления. Получить из list_template_folders. Возвращает: JSON со статусом ("deleted") и folder_id.

Параметры

  • folder_idstringобязательный
  • accountany
delete_verified_domainидемпотентный

Удаляет верифицированный домен отправки из аккаунта навсегда. Необратимо. После удаления домен нельзя использовать как адрес отправки до повторной верификации. Сначала вызовите list_verified_domains, чтобы найти доменные имена. Аргументы: domain_name: домен отправки для удаления (например, 'mail.example.com'). Получить из list_verified_domains. Возвращает: JSON со статусом ("deleted") и domain_name.

Удаляет верифицированный домен отправки из аккаунта навсегда. Необратимо. После удаления домен нельзя использовать как адрес отправки до повторной верификации. Сначала вызовите list_verified_domains, чтобы найти доменные имена. Аргументы: domain_name: домен отправки для удаления (например, 'mail.example.com'). Получить из list_verified_domains. Возвращает: JSON со статусом ("deleted") и domain_name.

Параметры

  • domain_namestringобязательный
  • accountany
delete_webhookидемпотентный

Удаляет вебхук, немедленно прекращая отправку уведомлений о событиях на его URL. Необратимо. Не используйте, если хотите временно приостановить уведомления — у вебхуков нет механизма паузы. После удаления создайте новый вебхук с помощью create_webhook. Возвращает ошибку 404, если webhook_id или list_id недействительны. Аргументы: list_id: ID аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. webhook_id: ID вебхука для удаления. Получить из list_webhooks. Возвращает: JSON со статусом ("deleted") и webhook_id.

Удаляет вебхук, немедленно прекращая отправку уведомлений о событиях на его URL. Необратимо. Не используйте, если хотите временно приостановить уведомления — у вебхуков нет механизма паузы. После удаления создайте новый вебхук с помощью create_webhook. Возвращает ошибку 404, если webhook_id или list_id недействительны. Аргументы: list_id: ID аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. webhook_id: ID вебхука для удаления. Получить из list_webhooks. Возвращает: JSON со статусом ("deleted") и webhook_id.

Параметры

  • list_idstringобязательный
  • webhook_idstringобязательный
  • accountany
describe_toolsтолько чтение

Перечисляет каждый инструмент с его машинно-читаемой классификацией риска для применения политик. Используйте это, чтобы узнать, какие инструменты являются чтением, обратимыми записями или разрушительными (необратимыми) перед предоставлением доступа или созданием автоматизации. Шлюз безопасности времени выполнения также может читать тот же сигнал из аннотаций инструментов MCP (readOnlyHint / destructiveHint / idempotentHint), доступных через tools/list; этот инструмент — удобное представление этих метаданных на основе вызовов инструментов. Без сетевого вызова. Только чтение, безопасно повторять. Возвращает: JSON с сводкой (количество по уровням риска и общее количество разрушительных) и массивом tools. Каждый: name, risk ('read' | 'write' | 'destructive'), read_only (bool), destructive (bool), idempotent (bool).

Перечисляет каждый инструмент с его машинно-читаемой классификацией риска для применения политик. Используйте это, чтобы узнать, какие инструменты являются чтением, обратимыми записями или разрушительными (необратимыми) перед предоставлением доступа или созданием автоматизации. Шлюз безопасности времени выполнения также может читать тот же сигнал из аннотаций инструментов MCP (readOnlyHint / destructiveHint / idempotentHint), доступных через tools/list; этот инструмент — удобное представление этих метаданных на основе вызовов инструментов. Без сетевого вызова. Только чтение, безопасно повторять. Возвращает: JSON с сводкой (количество по уровням риска и общее количество разрушительных) и массивом tools. Каждый: name, risk ('read' | 'write' | 'destructive'), read_only (bool), destructive (bool), idempotent (bool).

Параметры

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

get_account_exportтолько чтение

Получить статус и URL для скачивания отдельной задачи экспорта аккаунта. Используется для опроса экспорта, пока его статус не станет finished, после чего читается download_url. Чтобы просмотреть все экспорты и найти ID, используйте list_account_exports. Аргументы: export_id: ID задачи экспорта, которую нужно проверить. Берётся из list_account_exports или create_account_export. Возвращает: JSON с полями export_id, status, started (ISO 8601), finished (ISO 8601 или null), size_in_bytes, download_url.

Получить статус и URL для скачивания отдельной задачи экспорта аккаунта. Используется для опроса экспорта, пока его статус не станет finished, после чего читается download_url. Чтобы просмотреть все экспорты и найти ID, используйте list_account_exports. Аргументы: export_id: ID задачи экспорта, которую нужно проверить. Берётся из list_account_exports или create_account_export. Возвращает: JSON с полями export_id, status, started (ISO 8601), finished (ISO 8601 или null), size_in_bytes, download_url.

Параметры

  • export_idstringобязательный
  • accountany
get_account_infoтолько чтение

Получает детали аккаунта Mailchimp: название, контактную информацию, общее число подписчиков и отраслевые бенчмарки. Используйте для проверки подключения к API или просмотра метрик на уровне аккаунта. Обычно первый вызов в рабочем процессе. Не используйте эту функцию как проверку работоспособности — для этого используйте ping (быстрее, без тела запроса). Для статистики по каждой аудитории используйте list_audiences. Возвращает: JSON с полями: account_name (строка), email (владелец аккаунта), first_name, last_name, total_subscribers (целое, сумма всех аудиторий), industry_stats (объект с отраслевыми бенчмарками открытий/кликов для отрасли аккаунта). Возвращает объект ошибки, если ключ API недействителен или отсутствует. Пример: get_account_info() -> {"account_name": "My Company", "total_subscribers": 5000, "industry_stats": {"open_rate": 0.21, ...}}

Получает детали аккаунта Mailchimp: название, контактную информацию, общее число подписчиков и отраслевые бенчмарки. Используйте для проверки подключения к API или просмотра метрик на уровне аккаунта. Обычно первый вызов в рабочем процессе. Не используйте эту функцию как проверку работоспособности — для этого используйте ping (быстрее, без тела запроса). Для статистики по каждой аудитории используйте list_audiences. Возвращает: JSON с полями: account_name (строка), email (владелец аккаунта), first_name, last_name, total_subscribers (целое, сумма всех аудиторий), industry_stats (объект с отраслевыми бенчмарками открытий/кликов для отрасли аккаунта). Возвращает объект ошибки, если ключ API недействителен или отсутствует. Пример: get_account_info() -> {"account_name": "My Company", "total_subscribers": 5000, "industry_stats": {"open_rate": 0.21, ...}}

Параметры

  • accountany
get_audience_abuse_reportтолько чтение

Получает детали одной жалобы на спам для аудитории. Используйте, чтобы посмотреть, к какому подписчику и кампании относится конкретная жалоба. Используйте list_audience_abuse_reports, чтобы просмотреть все отчёты и найти значения report_id. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. report_id: ID отчёта о злоупотреблении. Получить из list_audience_abuse_reports. Возвращает: JSON с полями id, campaign_id, list_id, email_id, email_address, merge_fields, vip (логическое), date (ISO 8601). Возвращает ошибку, если list_id или report_id недействительны.

Получает детали одной жалобы на спам для аудитории. Используйте, чтобы посмотреть, к какому подписчику и кампании относится конкретная жалоба. Используйте list_audience_abuse_reports, чтобы просмотреть все отчёты и найти значения report_id. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. report_id: ID отчёта о злоупотреблении. Получить из list_audience_abuse_reports. Возвращает: JSON с полями id, campaign_id, list_id, email_id, email_address, merge_fields, vip (логическое), date (ISO 8601). Возвращает ошибку, если list_id или report_id недействительны.

Параметры

  • list_idstringобязательный
  • report_idstringобязательный
  • accountany
get_audience_activityтолько чтение

Получить дневную активность аудитории за последнее время (открытия, клики, отправки, подписки). Используйте, чтобы проверить историю вовлеченности аудитории по дням за последний период. Для сводной статистики используйте get_audience_details, а для результатов по каждой кампании — list_campaigns. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. count: Количество записей дневной активности для возврата (1–1000, по умолчанию 10). offset: Смещение страницы. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом activity. Каждая запись: day (дата), emails_sent, unique_opens, recipient_clicks, hard_bounce, soft_bounce, subs, unsubs, other_adds, other_removes.

Получить дневную активность аудитории за последнее время (открытия, клики, отправки, подписки). Используйте, чтобы проверить историю вовлеченности аудитории по дням за последний период. Для сводной статистики используйте get_audience_details, а для результатов по каждой кампании — list_campaigns. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. count: Количество записей дневной активности для возврата (1–1000, по умолчанию 10). offset: Смещение страницы. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом activity. Каждая запись: day (дата), emails_sent, unique_opens, recipient_clicks, hard_bounce, soft_bounce, subs, unsubs, other_adds, other_removes.

Параметры

  • list_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
get_audience_clientsтолько чтение

Выводит список основных почтовых клиентов (Gmail, Apple Mail, Outlook), используемых участниками аудитории. Используйте, чтобы принимать решения по отображению и дизайну писем на основе того, какие клиенты преобладают в аудитории. Для распределения по географическим регионам используйте get_audience_top_locations. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получите из list_audiences. count: Количество почтовых клиентов для возврата (1-1000, по умолчанию 10). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом clients. Каждый элемент: client (название почтового клиента) и members (количество участников аудитории, использующих этот клиент).

Выводит список основных почтовых клиентов (Gmail, Apple Mail, Outlook), используемых участниками аудитории. Используйте, чтобы принимать решения по отображению и дизайну писем на основе того, какие клиенты преобладают в аудитории. Для распределения по географическим регионам используйте get_audience_top_locations. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получите из list_audiences. count: Количество почтовых клиентов для возврата (1-1000, по умолчанию 10). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом clients. Каждый элемент: client (название почтового клиента) и members (количество участников аудитории, использующих этот клиент).

Параметры

  • list_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
get_audience_detailsтолько чтение

Получить полную статистику, URL подписки и рейтинг для конкретной аудитории. Используйте, когда у вас есть list_id и нужны подробные метрики или публичный URL подписки. Вместо этого используйте list_audiences для просмотра всех аудиторий и поиска list_ids. Возвращает ошибку 404, если list_id недействителен. Аргументы: list_id: Идентификатор аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. Возвращает: JSON с id, name, stats (member_count, unsubscribe_count, open_rate, click_rate), date_created, list_rating (0-5), subscribe_url_short и настройками аудитории: campaign_defaults (from_name, from_email, subject, language), double_optin (bool: true = подтверждённый/двойное согласие), marketing_permissions (bool: включены поля разрешений GDPR), email_type_option (bool).

Получить полную статистику, URL подписки и рейтинг для конкретной аудитории. Используйте, когда у вас есть list_id и нужны подробные метрики или публичный URL подписки. Вместо этого используйте list_audiences для просмотра всех аудиторий и поиска list_ids. Возвращает ошибку 404, если list_id недействителен. Аргументы: list_id: Идентификатор аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. Возвращает: JSON с id, name, stats (member_count, unsubscribe_count, open_rate, click_rate), date_created, list_rating (0-5), subscribe_url_short и настройками аудитории: campaign_defaults (from_name, from_email, subject, language), double_optin (bool: true = подтверждённый/двойное согласие), marketing_permissions (bool: включены поля разрешений GDPR), email_type_option (bool).

Параметры

  • list_idstringобязательный
  • accountany
get_audience_growth_historyтолько чтение

Получить историю ежемесячного роста аудитории (подписки, отписки, очищенные). Каждая запись — один календарный месяц, отсортированы от новых к старым. Используйте get_audience_details для получения текущих итогов вместо исторических трендов. Аргументы: list_id: идентификатор аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получите из list_audiences. count: количество месяцев для возврата (1-1000, по умолчанию 12). Возвращает: JSON с list_id и массивом history. Каждый элемент: month (ГГГГ-ММ), subscribed, unsubscribed, reconfirm, cleaned, pending, transactional (все накопительные целые числа).

Получить историю ежемесячного роста аудитории (подписки, отписки, очищенные). Каждая запись — один календарный месяц, отсортированы от новых к старым. Используйте get_audience_details для получения текущих итогов вместо исторических трендов. Аргументы: list_id: идентификатор аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получите из list_audiences. count: количество месяцев для возврата (1-1000, по умолчанию 12). Возвращает: JSON с list_id и массивом history. Каждый элемент: month (ГГГГ-ММ), subscribed, unsubscribed, reconfirm, cleaned, pending, transactional (все накопительные целые числа).

Параметры

  • list_idstringобязательный
  • countinteger
  • accountany
get_audience_top_locationsтолько чтение

Выводит список основных географических местоположений (стран) участников аудитории. Используйте, чтобы понять, где находится аудитория для регионального таргетинга или отчетности. Для разбивки по географии открытий одной кампании используйте get_campaign_locations. Аргументы: list_id: идентификатор аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. count: количество возвращаемых местоположений (1-1000, по умолчанию 10). offset: смещение для пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом locations. Каждый элемент: country (страна), cc (2-символьный код страны), percent (доля аудитории), total (количество участников в этой стране).

Выводит список основных географических местоположений (стран) участников аудитории. Используйте, чтобы понять, где находится аудитория для регионального таргетинга или отчетности. Для разбивки по географии открытий одной кампании используйте get_campaign_locations. Аргументы: list_id: идентификатор аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. count: количество возвращаемых местоположений (1-1000, по умолчанию 10). offset: смещение для пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом locations. Каждый элемент: country (страна), cc (2-символьный код страны), percent (доля аудитории), total (количество участников в этой стране).

Параметры

  • list_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
get_authorized_appтолько чтение

Получает полную запись одного OAuth-авторизованного приложения. Используйте, когда у вас есть ID приложения и нужно узнать его название, описание или пользователей, которые его авторизовали. Вместо этого используйте list_authorized_apps для просмотра всех приложений и получения их ID. Аргументы: app_id: ID авторизованного приложения для проверки. Получить из list_authorized_apps. Возвращает: JSON с id, name, description, users (массив имен учетных записей, которые его авторизовали).

Получает полную запись одного OAuth-авторизованного приложения. Используйте, когда у вас есть ID приложения и нужно узнать его название, описание или пользователей, которые его авторизовали. Вместо этого используйте list_authorized_apps для просмотра всех приложений и получения их ID. Аргументы: app_id: ID авторизованного приложения для проверки. Получить из list_authorized_apps. Возвращает: JSON с id, name, description, users (массив имен учетных записей, которые его авторизовали).

Параметры

  • app_idstringобязательный
  • accountany
get_automation_emailтолько чтение

Получает сведения об одном письме в классическом автоматизированном рабочем процессе. Извлекает конфигурацию и статус одного автоматизированного письма, идентифицированного по его workflow и email ID. Используйте этот инструмент для просмотра конкретного шага перед приостановкой, запуском или постановкой в очередь подписчиков. Аргументы: workflow_id: Уникальный идентификатор классического автоматизированного рабочего процесса. workflow_email_id: Уникальный идентификатор автоматизированного письма внутри рабочего процесса. Возвращает: JSON с деталями автоматизированного письма.

Получает сведения об одном письме в классическом автоматизированном рабочем процессе. Извлекает конфигурацию и статус одного автоматизированного письма, идентифицированного по его workflow и email ID. Используйте этот инструмент для просмотра конкретного шага перед приостановкой, запуском или постановкой в очередь подписчиков. Аргументы: workflow_id: Уникальный идентификатор классического автоматизированного рабочего процесса. workflow_email_id: Уникальный идентификатор автоматизированного письма внутри рабочего процесса. Возвращает: JSON с деталями автоматизированного письма.

Параметры

  • workflow_idstringобязательный
  • workflow_email_idstringобязательный
  • accountany
get_automation_email_queueтолько чтение

Получить очередь подписчиков, которые скоро получат конкретное письмо из автоматизации, с запланированным временем отправки. Используйте, чтобы увидеть, кто ждёт получения конкретного письма в воркфлоу. Сначала вызовите get_automation_emails, чтобы найти значения email_id внутри воркфлоу. Аргументы: automation_id: ID воркфлоу автоматизации (например, 'auto123'). Получите из list_automations. email_id: ID конкретного письма внутри автоматизации. Получите из get_automation_emails. Возвращает: JSON с total_items (int) и массивом queue. Каждая запись: email_address (string), next_send (ISO 8601 timestamp запланированной отправки). Пример: get_automation_email_queue(automation_id="auto123", email_id="email456") -> {"total_items": 12, "queue": [{"email_address": "jane@co.com", "next_send": "2025-06-02T10:00:00Z"}]}

Получить очередь подписчиков, которые скоро получат конкретное письмо из автоматизации, с запланированным временем отправки. Используйте, чтобы увидеть, кто ждёт получения конкретного письма в воркфлоу. Сначала вызовите get_automation_emails, чтобы найти значения email_id внутри воркфлоу. Аргументы: automation_id: ID воркфлоу автоматизации (например, 'auto123'). Получите из list_automations. email_id: ID конкретного письма внутри автоматизации. Получите из get_automation_emails. Возвращает: JSON с total_items (int) и массивом queue. Каждая запись: email_address (string), next_send (ISO 8601 timestamp запланированной отправки). Пример: get_automation_email_queue(automation_id="auto123", email_id="email456") -> {"total_items": 12, "queue": [{"email_address": "jane@co.com", "next_send": "2025-06-02T10:00:00Z"}]}

Параметры

  • automation_idstringобязательный
  • email_idstringобязательный
  • accountany
get_automation_emailsтолько чтение

Перечисляет отдельные письма внутри автоматизации с указанием последовательности, задержек и количества отправок. Возвращает все письма независимо от статуса. Не путать с get_email_activity (вовлеченность в кампанию). Используйте get_automation_email_queue, чтобы просмотреть подписчиков в очереди для конкретного письма. Аргументы: automation_id: Идентификатор автоматизации (например, 'auto123'). Получить из list_automations. Возвращает: JSON с полями total_items и массивом emails. Каждое письмо: id, position (последовательность, начиная с 1), status ('sending'/'paused'/'draft'), subject_line, title, emails_sent, send_time, delay.

Перечисляет отдельные письма внутри автоматизации с указанием последовательности, задержек и количества отправок. Возвращает все письма независимо от статуса. Не путать с get_email_activity (вовлеченность в кампанию). Используйте get_automation_email_queue, чтобы просмотреть подписчиков в очереди для конкретного письма. Аргументы: automation_id: Идентификатор автоматизации (например, 'auto123'). Получить из list_automations. Возвращает: JSON с полями total_items и массивом emails. Каждое письмо: id, position (последовательность, начиная с 1), status ('sending'/'paused'/'draft'), subject_line, title, emails_sent, send_time, delay.

Параметры

  • automation_idstringобязательный
  • accountany
get_automation_queue_subscriberтолько чтение

Получает одного подписчика из очереди классического автоматизационного письма. Извлекает статус очереди для конкретного подписчика в автоматизационном письме. Подписчик находится путем хеширования указанного email-адреса. Аргументы: workflow_id: Уникальный идентификатор классического автоматизационного workflow. workflow_email_id: Уникальный идентификатор автоматизационного письма, очередь которого нужно проверить. email_address: Email-адрес подписчика в очереди, которого нужно найти. Возвращает: JSON с деталями подписчика из очереди.

Получает одного подписчика из очереди классического автоматизационного письма. Извлекает статус очереди для конкретного подписчика в автоматизационном письме. Подписчик находится путем хеширования указанного email-адреса. Аргументы: workflow_id: Уникальный идентификатор классического автоматизационного workflow. workflow_email_id: Уникальный идентификатор автоматизационного письма, очередь которого нужно проверить. email_address: Email-адрес подписчика в очереди, которого нужно найти. Возвращает: JSON с деталями подписчика из очереди.

Параметры

  • workflow_idstringобязательный
  • workflow_email_idstringобязательный
  • email_addressstringобязательный
  • accountany
get_automation_removed_subscriberтолько чтение

Получает одного удаленного подписчика из классического workflow автоматизации. Получает сведения о конкретном подписчике, удаленном из workflow автоматизации. Подписчик определяется по хешу предоставленного email-адреса. Аргументы: workflow_id: уникальный идентификатор классического workflow автоматизации. email_address: email-адрес удаленного подписчика для поиска. Возвращает: JSON с данными удаленного подписчика.

Получает одного удаленного подписчика из классического workflow автоматизации. Получает сведения о конкретном подписчике, удаленном из workflow автоматизации. Подписчик определяется по хешу предоставленного email-адреса. Аргументы: workflow_id: уникальный идентификатор классического workflow автоматизации. email_address: email-адрес удаленного подписчика для поиска. Возвращает: JSON с данными удаленного подписчика.

Параметры

  • workflow_idstringобязательный
  • email_addressstringобязательный
  • accountany
get_automation_summaryтолько чтение

Обобщает активность автоматизаций в Classic Automations и Customer Journeys. Объединяет два API-вызова в один обзор, полезный для аудитов и дашбордов: 1. /automations — считает Classic-воркфлоу по статусам (sending / paused / draft) 2. /campaigns?type=automation&since_send_time=N days ago — считает и суммирует, какие автоматизации реально отправляли письма в последнее время (письма из Classic и Customer Journey приходят как кампании с type='automation') Это рекомендуемая отправная точка для вопросов вроде «что сейчас делает мой стек автоматизаций?» во время аудита аккаунта. Используйте list_automations для сырого списка Classic. Используйте search_automation_campaigns для сырой ленты недавних автоматизационных кампаний. Только чтение, безопасно повторять. Аргументы: days: Окно просмотра в днях для части с недавними отправками (1-365, по умолчанию 30). Возвращает: JSON с двумя разделами: - classic_automations: total, by_status ({sending, paused, draft, ...}) - recent_automation_campaigns: window_days, total_campaigns, total_emails_sent, top_titles (до 5 названий, отсортированных по emails_sent по убыванию)

Обобщает активность автоматизаций в Classic Automations и Customer Journeys. Объединяет два API-вызова в один обзор, полезный для аудитов и дашбордов: 1. /automations — считает Classic-воркфлоу по статусам (sending / paused / draft) 2. /campaigns?type=automation&since_send_time=N days ago — считает и суммирует, какие автоматизации реально отправляли письма в последнее время (письма из Classic и Customer Journey приходят как кампании с type='automation') Это рекомендуемая отправная точка для вопросов вроде «что сейчас делает мой стек автоматизаций?» во время аудита аккаунта. Используйте list_automations для сырого списка Classic. Используйте search_automation_campaigns для сырой ленты недавних автоматизационных кампаний. Только чтение, безопасно повторять. Аргументы: days: Окно просмотра в днях для части с недавними отправками (1-365, по умолчанию 30). Возвращает: JSON с двумя разделами: - classic_automations: total, by_status ({sending, paused, draft, ...}) - recent_automation_campaigns: window_days, total_campaigns, total_emails_sent, top_titles (до 5 названий, отсортированных по emails_sent по убыванию)

Параметры

  • daysinteger
  • accountany
get_batch_statusтолько чтение

_body_url: написать "response_body_url (строка, загружаемый tar.gz-архив с результатами каждой операции, доступен только когда статус 'finished')". Можно "доступен только при статусе 'finished'". Убедимся, что нет лишних слов._body_url - это имя параметра, не переводим. "загружаемый tar.gz-архив" - ок. "с результатами по каждой операции" - лучше "с результатами каждой операции". Всё.Проверяет ход выполнения и статус завершения асинхронной пакетной операции. Используйте после create_batch для опроса о завершении. Вызывайте повторно, пока статус не станет 'finished'. Не используйте для непакетных операций. Используйте list_batches для просмотра всех недавних пакетных операций. Аргументы: batch_id: Идентификатор пакетной операции (например, 'batch123abc'). Получите из create_batch. Возвращает: JSON с полями: id, status ('pending' = в очереди, 'started' = выполняется, 'finished' = завершена), total_operations (целое), finished_operations (целое), errored_operations (целое), submitted_at (ISO 8601), completed_at (ISO 8601 или null), response_body_url (строка, загружаемый tar.gz-архив с результатами каждой операции, доступен только когда статус 'finished'). Пример: get_batch_status(batch_id="batch123") -> {"status": "finished", "total_operations": 100, "finished_operations": 100, "errored_operations": 2, "response_body_url": "https://...", ...}

_body_url: написать "response_body_url (строка, загружаемый tar.gz-архив с результатами каждой операции, доступен только когда статус 'finished')". Можно "доступен только при статусе 'finished'". Убедимся, что нет лишних слов._body_url - это имя параметра, не переводим. "загружаемый tar.gz-архив" - ок. "с результатами по каждой операции" - лучше "с результатами каждой операции". Всё.Проверяет ход выполнения и статус завершения асинхронной пакетной операции. Используйте после create_batch для опроса о завершении. Вызывайте повторно, пока статус не станет 'finished'. Не используйте для непакетных операций. Используйте list_batches для просмотра всех недавних пакетных операций. Аргументы: batch_id: Идентификатор пакетной операции (например, 'batch123abc'). Получите из create_batch. Возвращает: JSON с полями: id, status ('pending' = в очереди, 'started' = выполняется, 'finished' = завершена), total_operations (целое), finished_operations (целое), errored_operations (целое), submitted_at (ISO 8601), completed_at (ISO 8601 или null), response_body_url (строка, загружаемый tar.gz-архив с результатами каждой операции, доступен только когда статус 'finished'). Пример: get_batch_status(batch_id="batch123") -> {"status": "finished", "total_operations": 100, "finished_operations": 100, "errored_operations": 2, "response_body_url": "https://...", ...}

Параметры

  • batch_idstringобязательный
  • accountany
get_batch_webhookтолько чтение

Возвращает детали одного batch webhook. Используйте, чтобы проверить целевой URL и состояние включения batch webhook. Для просмотра всех batch webhook и получения значений batch_webhook_id используйте list_batch_webhooks. Аргументы: batch_webhook_id: ID batch webhook. Получите из list_batch_webhooks. Возвращает: JSON с полями id, url, enabled (логическое). Возвращает ошибку, если batch_webhook_id недействителен.

Возвращает детали одного batch webhook. Используйте, чтобы проверить целевой URL и состояние включения batch webhook. Для просмотра всех batch webhook и получения значений batch_webhook_id используйте list_batch_webhooks. Аргументы: batch_webhook_id: ID batch webhook. Получите из list_batch_webhooks. Возвращает: JSON с полями id, url, enabled (логическое). Возвращает ошибку, если batch_webhook_id недействителен.

Параметры

  • batch_webhook_idstringобязательный
  • accountany
get_campaign_abuse_reportтолько чтение

Получить одну жалобу на спам для отправленной кампании. Используйте, чтобы посмотреть детали одной жалобы: кто из подписчиков её подал и когда. Чтобы найти ID отчётов, используйте get_campaign_abuse_reports. Аргументы: campaign_id: ID отправленной кампании. Получите из list_campaigns или search_campaigns. report_id: ID отчёта о жалобе. Получите из get_campaign_abuse_reports. Возвращает: JSON с полями id, campaign_id, list_id, email_id, email_address, date, merge_fields, vip.

Получить одну жалобу на спам для отправленной кампании. Используйте, чтобы посмотреть детали одной жалобы: кто из подписчиков её подал и когда. Чтобы найти ID отчётов, используйте get_campaign_abuse_reports. Аргументы: campaign_id: ID отправленной кампании. Получите из list_campaigns или search_campaigns. report_id: ID отчёта о жалобе. Получите из get_campaign_abuse_reports. Возвращает: JSON с полями id, campaign_id, list_id, email_id, email_address, date, merge_fields, vip.

Параметры

  • campaign_idstringобязательный
  • report_idstringобязательный
  • accountany
get_campaign_abuse_reportsтолько чтение

Выводит жалобы на злоупотребления (спам), поданные на отправленную кампанию. Используйте для мониторинга доставляемости: большое количество жалоб указывает на проблемы с качеством списка или контентом. Для деталей одной жалобы вызывайте get_campaign_abuse_report. Для общей статистики — get_campaign_report. Аргументы: campaign_id: ID отправленной кампании. Получите из list_campaigns или search_campaigns. Возвращает: JSON с total_items и массивом abuse_reports. Каждый элемент: id, campaign_id, list_id, email_id, email_address, date.

Выводит жалобы на злоупотребления (спам), поданные на отправленную кампанию. Используйте для мониторинга доставляемости: большое количество жалоб указывает на проблемы с качеством списка или контентом. Для деталей одной жалобы вызывайте get_campaign_abuse_report. Для общей статистики — get_campaign_report. Аргументы: campaign_id: ID отправленной кампании. Получите из list_campaigns или search_campaigns. Возвращает: JSON с total_items и массивом abuse_reports. Каждый элемент: id, campaign_id, list_id, email_id, email_address, date.

Параметры

  • campaign_idstringобязательный
  • accountany
get_campaign_adviceтолько чтение

Извлекает автоматические рекомендации Mailchimp после отправки кампании (тема письма, содержание, советы по вовлечённости). Используй, чтобы достать алгоритмические подсказки, которые Mailchimp генерирует после анализа эффективности кампании (например: «ваш показатель открытий ниже среднего по индустрии — попробуйте более короткие темы писем»). Для сырых метрик используй get_campaign_report. Работает только для отправленных кампаний. Возвращает ошибку 404, если campaign_id некорректен. Возвращает пустой массив advice, если у Mailchimp нет предложений для этой кампании. Аргументы: campaign_id: ID кампании в Mailchimp (например, 'abc123def4'). Обязательно отправленная кампания. Возвращает: JSON с полями total_items и массивом advice. Каждый элемент: type ('positive' | 'negative' | 'neutral'), message (строка, текст совета).

Извлекает автоматические рекомендации Mailchimp после отправки кампании (тема письма, содержание, советы по вовлечённости). Используй, чтобы достать алгоритмические подсказки, которые Mailchimp генерирует после анализа эффективности кампании (например: «ваш показатель открытий ниже среднего по индустрии — попробуйте более короткие темы писем»). Для сырых метрик используй get_campaign_report. Работает только для отправленных кампаний. Возвращает ошибку 404, если campaign_id некорректен. Возвращает пустой массив advice, если у Mailchimp нет предложений для этой кампании. Аргументы: campaign_id: ID кампании в Mailchimp (например, 'abc123def4'). Обязательно отправленная кампания. Возвращает: JSON с полями total_items и массивом advice. Каждый элемент: type ('positive' | 'negative' | 'neutral'), message (строка, текст совета).

Параметры

  • campaign_idstringобязательный
  • accountany
get_campaign_click_detailsтолько чтение

Извлекает данные о кликах по каждой ссылке для кампании: какие URL были нажаты и сколько раз. Используйте, чтобы проанализировать, какие ссылки вызвали вовлечение. Вместо неё используйте `get_campaign_report` для получения общих показателей (открытия, клики, отказы). Используйте `get_email_activity` для просмотра временной шкалы кликов по каждому получателю. Работает только для отправленных кампаний. Аргументы: - `campaign_id` — идентификатор кампании Mailchimp (например, `'abc123def4'`). Кампания должна быть отправлена. - `count` — количество возвращаемых URL-результатов (от 1 до 1000, по умолчанию 20). Возвращает: JSON с полем `total_items` и массивом `links`. Каждый элемент `links` содержит: - `url` (строка) — URL ссылки. - `total_clicks` (целое число) — всего кликов, включая повторные. - `unique_clicks` (целое число) — уникальные клики (один на подписчика). - `click_percentage` (десятичная дробь от 0 до 1) — процент кликов. Пример: `get_campaign_click_details(campaign_id="abc123")` → `{"total_items": 5, "links": [{"url": "https://example.com", "total_clicks": 120, "unique_clicks": 95, "click_percentage": 0.019}]}`

Извлекает данные о кликах по каждой ссылке для кампании: какие URL были нажаты и сколько раз. Используйте, чтобы проанализировать, какие ссылки вызвали вовлечение. Вместо неё используйте `get_campaign_report` для получения общих показателей (открытия, клики, отказы). Используйте `get_email_activity` для просмотра временной шкалы кликов по каждому получателю. Работает только для отправленных кампаний. Аргументы: - `campaign_id` — идентификатор кампании Mailchimp (например, `'abc123def4'`). Кампания должна быть отправлена. - `count` — количество возвращаемых URL-результатов (от 1 до 1000, по умолчанию 20). Возвращает: JSON с полем `total_items` и массивом `links`. Каждый элемент `links` содержит: - `url` (строка) — URL ссылки. - `total_clicks` (целое число) — всего кликов, включая повторные. - `unique_clicks` (целое число) — уникальные клики (один на подписчика). - `click_percentage` (десятичная дробь от 0 до 1) — процент кликов. Пример: `get_campaign_click_details(campaign_id="abc123")` → `{"total_items": 5, "links": [{"url": "https://example.com", "total_clicks": 120, "unique_clicks": 95, "click_percentage": 0.019}]}`

Параметры

  • campaign_idstringобязательный
  • countinteger
  • accountany
get_campaign_contentтолько чтение

Читает отрендеренное тело письма кампании (простой текст, опционально HTML). Используйте, чтобы получить копию письма, которая была отправлена, для аудита контента, анализа или повторного использования. Для настроек/метаданных (тема письма, отправитель) используйте get_campaign_details, а для статистики после отправки — get_campaign_report. Чтобы найти ID кампаний, используйте list_campaigns или search_campaigns. Аргументы: campaign_id: ID кампании Mailchimp (например, 'abc123def4'). Получите через list_campaigns или search_campaigns. Это API-идентификатор, а не числовой web_id из URL панели управления. include_html: Когда True, также возвращает сырое HTML-тело. По умолчанию False, чтобы ответы оставались компактными; для большинства задач с контентом достаточно plain_text. Возвращает: JSON с campaign_id и plain_text (тело в простом тексте); html добавляется только когда include_html=True. Для A/B (вариантных) кампаний включается массив variations с одной записью на каждый вариант контента: {label, plain_text и html, когда include_html=True}. Очень длинные тела обрезаются (см. MAILCHIMP_MAX_CONTENT_CHARS); в этом случае поле truncated указывает, какие части были затронуты. Возвращает ошибку, если campaign_id недействителен или у кампании нет контента. Пример: get_campaign_content(campaign_id="abc123def4") -> {"campaign_id": "abc123def4", "plain_text": "Hi *|FNAME|* ..."}

Читает отрендеренное тело письма кампании (простой текст, опционально HTML). Используйте, чтобы получить копию письма, которая была отправлена, для аудита контента, анализа или повторного использования. Для настроек/метаданных (тема письма, отправитель) используйте get_campaign_details, а для статистики после отправки — get_campaign_report. Чтобы найти ID кампаний, используйте list_campaigns или search_campaigns. Аргументы: campaign_id: ID кампании Mailchimp (например, 'abc123def4'). Получите через list_campaigns или search_campaigns. Это API-идентификатор, а не числовой web_id из URL панели управления. include_html: Когда True, также возвращает сырое HTML-тело. По умолчанию False, чтобы ответы оставались компактными; для большинства задач с контентом достаточно plain_text. Возвращает: JSON с campaign_id и plain_text (тело в простом тексте); html добавляется только когда include_html=True. Для A/B (вариантных) кампаний включается массив variations с одной записью на каждый вариант контента: {label, plain_text и html, когда include_html=True}. Очень длинные тела обрезаются (см. MAILCHIMP_MAX_CONTENT_CHARS); в этом случае поле truncated указывает, какие части были затронуты. Возвращает ошибку, если campaign_id недействителен или у кампании нет контента. Пример: get_campaign_content(campaign_id="abc123def4") -> {"campaign_id": "abc123def4", "plain_text": "Hi *|FNAME|* ..."}

Параметры

  • campaign_idstringобязательный
  • include_htmlboolean
  • accountany
get_campaign_detailsтолько чтение

Получает полную конфигурацию конкретной кампании: настройки, получателей и параметры отслеживания. Используйте, чтобы проверить тему письма, отправителя, аудиторию или настройки отслеживания. Для статистики после отправки (открытия, клики, отказы) используйте `get_campaign_report`. Чтобы найти ID кампании, вызывайте `list_campaigns` или `search_campaigns`. Аргументы: campaign_id: ID кампании Mailchimp (например, `'abc123def4'`). Получить из `list_campaigns` или `search_campaigns`. Возвращает: JSON с полями: id, type, status, settings (subject_line, title, from_name, reply_to), recipients (list_id, segment_opts), send_time (ISO 8601 или null), emails_sent, tracking (opens, html_clicks, text_clicks — булевы). Возвращает ошибку, если campaign_id некорректен. Пример: get_campaign_details(campaign_id="abc123def4") -> {"id": "abc123def4", "status": "sent", "settings": {"subject_line": "Spring Sale", ...}}

Получает полную конфигурацию конкретной кампании: настройки, получателей и параметры отслеживания. Используйте, чтобы проверить тему письма, отправителя, аудиторию или настройки отслеживания. Для статистики после отправки (открытия, клики, отказы) используйте `get_campaign_report`. Чтобы найти ID кампании, вызывайте `list_campaigns` или `search_campaigns`. Аргументы: campaign_id: ID кампании Mailchimp (например, `'abc123def4'`). Получить из `list_campaigns` или `search_campaigns`. Возвращает: JSON с полями: id, type, status, settings (subject_line, title, from_name, reply_to), recipients (list_id, segment_opts), send_time (ISO 8601 или null), emails_sent, tracking (opens, html_clicks, text_clicks — булевы). Возвращает ошибку, если campaign_id некорректен. Пример: get_campaign_details(campaign_id="abc123def4") -> {"id": "abc123def4", "status": "sent", "settings": {"subject_line": "Spring Sale", ...}}

Параметры

  • campaign_idstringобязательный
  • accountany
get_campaign_feedbackтолько чтение

Получить один комментарий команды к кампании. Используйте, чтобы прочитать полный текст и метаданные одного комментария по коллаборации. Используйте list_campaign_feedback, чтобы узнать идентификаторы комментариев. Аргументы: campaign_id: ID кампании, к которой относится комментарий. Получить из list_campaigns. feedback_id: ID комментария. Получить из list_campaign_feedback. Возвращает: JSON с полями feedback_id, message, is_complete, block_id, created_by, created_at, updated_at.

Получить один комментарий команды к кампании. Используйте, чтобы прочитать полный текст и метаданные одного комментария по коллаборации. Используйте list_campaign_feedback, чтобы узнать идентификаторы комментариев. Аргументы: campaign_id: ID кампании, к которой относится комментарий. Получить из list_campaigns. feedback_id: ID комментария. Получить из list_campaign_feedback. Возвращает: JSON с полями feedback_id, message, is_complete, block_id, created_by, created_at, updated_at.

Параметры

  • campaign_idstringобязательный
  • feedback_idstringобязательный
  • accountany
get_campaign_folderтолько чтение

Получает данные об одной папке кампаний. Используется, чтобы подтвердить имя папки и количество кампаний в ней перед упорядочиванием кампаний. Используйте list_campaign_folders для получения ID папок. Аргументы: folder_id: ID папки кампаний. Получается из list_campaign_folders. Возвращает: JSON с id, name и количеством кампаний в папке.

Получает данные об одной папке кампаний. Используется, чтобы подтвердить имя папки и количество кампаний в ней перед упорядочиванием кампаний. Используйте list_campaign_folders для получения ID папок. Аргументы: folder_id: ID папки кампаний. Получается из list_campaign_folders. Возвращает: JSON с id, name и количеством кампаний в папке.

Параметры

  • folder_idstringобязательный
  • accountany
get_campaign_locationsтолько чтение

Получает географические данные об открытиях для отправленной кампании, с разбивкой по стране и региону. Используйте, чтобы отобразить, где произошли открытия: полезно для последующих действий по регионам, отправки с учётом часового пояса или аудиторских отчётов. Собирается на основе геолокации IP в момент открытия. Вместо этого используйте `get_domain_performance` для статистики по провайдерам. Работает только для отправленных кампаний. Аргументы: campaign_id: ID кампании Mailchimp (например, 'abc123def4'). Должна быть отправленной кампанией. count: Количество возвращаемых местоположений (1-1000, по умолчанию 20). offset: Смещение пагинации. Используйте, когда `total_items` превышает `count`. Возвращает: JSON с `total_items` и массивом `locations`. Каждая запись: `country_code` (ISO, 2 буквы, например 'US'), `region` (строка, название или код штата/провинции), `region_name` (полное название), `opens` (целое число, открытия из этого региона).

Получает географические данные об открытиях для отправленной кампании, с разбивкой по стране и региону. Используйте, чтобы отобразить, где произошли открытия: полезно для последующих действий по регионам, отправки с учётом часового пояса или аудиторских отчётов. Собирается на основе геолокации IP в момент открытия. Вместо этого используйте `get_domain_performance` для статистики по провайдерам. Работает только для отправленных кампаний. Аргументы: campaign_id: ID кампании Mailchimp (например, 'abc123def4'). Должна быть отправленной кампанией. count: Количество возвращаемых местоположений (1-1000, по умолчанию 20). offset: Смещение пагинации. Используйте, когда `total_items` превышает `count`. Возвращает: JSON с `total_items` и массивом `locations`. Каждая запись: `country_code` (ISO, 2 буквы, например 'US'), `region` (строка, название или код штата/провинции), `region_name` (полное название), `opens` (целое число, открытия из этого региона).

Параметры

  • campaign_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
get_campaign_recipientsтолько чтение

Получает список доставки для отправленной кампании: статус доставки каждого получателя и количество открытий. Используйте, чтобы проверить, кто получил кампанию и открывал ли он её. Для подробных временных шкал по каждому получателю (клики, отказы с метками времени) используйте get_email_activity. Для сводной статистики используйте get_campaign_report. Работает только для отправленных кампаний; для черновиков или запланированных возвращает ошибку. Аргументы: campaign_id: ID кампании Mailchimp (например 'abc123def4'). Должна быть отправленной кампанией. count: Количество получателей (1-1000, по умолчанию 20). offset: Смещение для пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items (int) и массивом recipients. Каждый recipient: email_address, status ('sent', 'hard', 'soft'), open_count (int), last_open (ISO 8601 или null). Пример: get_campaign_recipients(campaign_id="abc123", count=100) -> {"total_items": 5000, "recipients": [{"email_address": "jane@co.com", "status": "sent", "open_count": 3, ...}]}

Получает список доставки для отправленной кампании: статус доставки каждого получателя и количество открытий. Используйте, чтобы проверить, кто получил кампанию и открывал ли он её. Для подробных временных шкал по каждому получателю (клики, отказы с метками времени) используйте get_email_activity. Для сводной статистики используйте get_campaign_report. Работает только для отправленных кампаний; для черновиков или запланированных возвращает ошибку. Аргументы: campaign_id: ID кампании Mailchimp (например 'abc123def4'). Должна быть отправленной кампанией. count: Количество получателей (1-1000, по умолчанию 20). offset: Смещение для пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items (int) и массивом recipients. Каждый recipient: email_address, status ('sent', 'hard', 'soft'), open_count (int), last_open (ISO 8601 или null). Пример: get_campaign_recipients(campaign_id="abc123", count=100) -> {"total_items": 5000, "recipients": [{"email_address": "jane@co.com", "status": "sent", "open_count": 3, ...}]}

Параметры

  • campaign_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
get_campaign_reportтолько чтение

Получить сводные показатели эффективности для отправленной кампании: открытия, клики, отказы, бенчмарки. Обзор верхнего уровня. Используйте get_campaign_click_details для данных по каждой ссылке, get_open_details для открытий по каждому получателю, get_campaign_recipients для статуса доставки. Работает только для отправленных кампаний. Аргументы: campaign_id: ID кампании (например, 'abc123def4'). Должна быть отправлена. Получить из list_campaigns(status="sent"). Возвращает: JSON с campaign_title, subject_line, emails_sent, abuse_reports, unsubscribed, send_time, opens (opens_total, unique_opens, open_rate от 0 до 1), clicks (clicks_total, unique_clicks, click_rate), bounces, forwards, list_stats, industry_stats.

Получить сводные показатели эффективности для отправленной кампании: открытия, клики, отказы, бенчмарки. Обзор верхнего уровня. Используйте get_campaign_click_details для данных по каждой ссылке, get_open_details для открытий по каждому получателю, get_campaign_recipients для статуса доставки. Работает только для отправленных кампаний. Аргументы: campaign_id: ID кампании (например, 'abc123def4'). Должна быть отправлена. Получить из list_campaigns(status="sent"). Возвращает: JSON с campaign_title, subject_line, emails_sent, abuse_reports, unsubscribed, send_time, opens (opens_total, unique_opens, open_rate от 0 до 1), clicks (clicks_total, unique_clicks, click_rate), bounces, forwards, list_stats, industry_stats.

Параметры

  • campaign_idstringобязательный
  • accountany
get_campaign_send_checklistтолько чтение

Получает контрольный список готовности кампании к отправке. Используйте, чтобы проверить, готова ли кампания перед отправкой. Список отмечает отсутствующих получателей, темы писем, контент или другие блокирующие факторы. Устраните все элементы с типом 'error' перед вызовом send_campaign. Используйте get_campaign_details, чтобы найти ID кампаний. Аргументы: campaign_id: ID кампании для проверки. Получите из list_campaigns или search_campaigns. Возвращает: JSON с is_ready (boolean) и массивом items. Каждый элемент: type ('success'/'warning'/'error'), id, heading, details.

Получает контрольный список готовности кампании к отправке. Используйте, чтобы проверить, готова ли кампания перед отправкой. Список отмечает отсутствующих получателей, темы писем, контент или другие блокирующие факторы. Устраните все элементы с типом 'error' перед вызовом send_campaign. Используйте get_campaign_details, чтобы найти ID кампаний. Аргументы: campaign_id: ID кампании для проверки. Получите из list_campaigns или search_campaigns. Возвращает: JSON с is_ready (boolean) и массивом items. Каждый элемент: type ('success'/'warning'/'error'), id, heading, details.

Параметры

  • campaign_idstringобязательный
  • accountany
get_campaign_sent_toтолько чтение

Перечисляет получателей, которым была доставлена отправленная кампания, с указанием статуса для каждого. Используйте для аудита: кто именно получил кампанию и была ли доставка успешной или письмо вернулось. Для больших списков получателей используйте пагинацию с параметрами count и offset. Для агрегированной статистики используйте get_campaign_report. Аргументы: campaign_id: ID отправленной кампании. Получить из list_campaigns или search_campaigns. count: Количество возвращаемых получателей (1-1000, по умолчанию 10). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и sent_to (массив). Каждый элемент: email_id, email_address, status ('sent'/'bounced'), open_count, absplit_group, gmt_offset, merge_fields.

Перечисляет получателей, которым была доставлена отправленная кампания, с указанием статуса для каждого. Используйте для аудита: кто именно получил кампанию и была ли доставка успешной или письмо вернулось. Для больших списков получателей используйте пагинацию с параметрами count и offset. Для агрегированной статистики используйте get_campaign_report. Аргументы: campaign_id: ID отправленной кампании. Получить из list_campaigns или search_campaigns. count: Количество возвращаемых получателей (1-1000, по умолчанию 10). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и sent_to (массив). Каждый элемент: email_id, email_address, status ('sent'/'bounced'), open_count, absplit_group, gmt_offset, merge_fields.

Параметры

  • campaign_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
get_campaign_sub_reportsтолько чтение

Получает данные отчета для подэлементов A/B теста, вариации или RSS кампании. Только чтение, без побочных эффектов. Возвращает пустые данные для обычных кампаний; используйте get_campaign_report. Сначала проверьте тип кампании с помощью get_campaign_details ('absplit', 'variate', 'rss'). Аргументы: campaign_id: ID кампании (например, 'abc123def4'). Должен быть типа 'absplit', 'variate' или 'rss'. Получите из list_campaigns. Возвращает: JSON с подотчетами. Формат различается: A/B тесты включают открытия, клики, победителя по каждому варианту; RSS включает статистику отправки по каждому элементу с датами.

Получает данные отчета для подэлементов A/B теста, вариации или RSS кампании. Только чтение, без побочных эффектов. Возвращает пустые данные для обычных кампаний; используйте get_campaign_report. Сначала проверьте тип кампании с помощью get_campaign_details ('absplit', 'variate', 'rss'). Аргументы: campaign_id: ID кампании (например, 'abc123def4'). Должен быть типа 'absplit', 'variate' или 'rss'. Получите из list_campaigns. Возвращает: JSON с подотчетами. Формат различается: A/B тесты включают открытия, клики, победителя по каждому варианту; RSS включает статистику отправки по каждому элементу с датами.

Параметры

  • campaign_idstringобязательный
  • accountany
get_campaign_unsubscribesтолько чтение

Получить подписчиков, отписавшихся от конкретной отправленной кампании, с указанием причин. Вместо этого используйте get_campaign_report для получения общего числа отписавшихся. Возвращает ошибку 404, если campaign_id недействителен. Для неотправленных кампаний возвращает пустой массив. Параметры: campaign_id: ID кампании (например, 'abc123def4'). Должна быть отправленной кампанией. count: Количество записей для возврата (1-1000, по умолчанию 20). offset: Смещение для пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом unsubscribes. Каждый элемент: email_address, reason (строка или null), timestamp.

Получить подписчиков, отписавшихся от конкретной отправленной кампании, с указанием причин. Вместо этого используйте get_campaign_report для получения общего числа отписавшихся. Возвращает ошибку 404, если campaign_id недействителен. Для неотправленных кампаний возвращает пустой массив. Параметры: campaign_id: ID кампании (например, 'abc123def4'). Должна быть отправленной кампанией. count: Количество записей для возврата (1-1000, по умолчанию 20). offset: Смещение для пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом unsubscribes. Каждый элемент: email_address, reason (строка или null), timestamp.

Параметры

  • campaign_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
get_chimp_chatterтолько чтение

Получает ленту активности аккаунта (Chimp Chatter) последних событий по всему аккаунту. Используйте для просмотра хронологического потока общеаккаунтной активности, например отправок, импортов и изменений подписчиков. Для метрик по одной кампании используйте get_campaign_report. Args: count: Количество возвращаемых записей активности (1-1000, по умолчанию 10). offset: Смещение пагинации. Используйте, когда total_items превышает count. Returns: JSON с total_items и массивом chimp_chatter. Каждая запись: title, message, type, update_time, url, campaign_id, list_id.

Получает ленту активности аккаунта (Chimp Chatter) последних событий по всему аккаунту. Используйте для просмотра хронологического потока общеаккаунтной активности, например отправок, импортов и изменений подписчиков. Для метрик по одной кампании используйте get_campaign_report. Args: count: Количество возвращаемых записей активности (1-1000, по умолчанию 10). offset: Смещение пагинации. Используйте, когда total_items превышает count. Returns: JSON с total_items и массивом chimp_chatter. Каждая запись: title, message, type, update_time, url, campaign_id, list_id.

Параметры

  • countinteger
  • offsetinteger
  • accountany
get_connected_siteтолько чтение

Получить полную запись для одного подключенного сайта, включая его скрипт отслеживания. Используйте, когда у вас есть ID подключенного сайта и нужен его фрагмент скрипта или статус установки. Вместо этого используйте list_connected_sites для просмотра всех сайтов и получения ID. Аргументы: connected_site_id: ID подключенного сайта для проверки. Получите из list_connected_sites. Возвращает: JSON с полями id, foreign_id, domain, site_script (объект с полями url и fragment), status, created_at, updated_at.

Получить полную запись для одного подключенного сайта, включая его скрипт отслеживания. Используйте, когда у вас есть ID подключенного сайта и нужен его фрагмент скрипта или статус установки. Вместо этого используйте list_connected_sites для просмотра всех сайтов и получения ID. Аргументы: connected_site_id: ID подключенного сайта для проверки. Получите из list_connected_sites. Возвращает: JSON с полями id, foreign_id, domain, site_script (объект с полями url и fragment), status, created_at, updated_at.

Параметры

  • connected_site_idstringобязательный
  • accountany
get_domain_performanceтолько чтение

Получите статистику кампании с разбивкой по домену получателя (gmail.com, outlook.com и т.д.). Используйте, чтобы выявить проблемы с доставляемостью у конкретных провайдеров или сравнить вовлечённость по доменам. Для общих агрегированных метрик используйте get_campaign_report. Работает только для отправленных кампаний. Аргументы: campaign_id: ID кампании в Mailchimp (например 'abc123def4'). Обязательно отправленная кампания. Возвращает: JSON с total_items и массивом domains. Каждый domain: domain (строка, например 'gmail.com'), emails_sent (целое), bounces (целое), opens (целое), clicks (целое), unsubs (целое). Пример: get_domain_performance(campaign_id="abc123") -> {"total_items": 15, "domains": [{"domain": "gmail.com", "emails_sent": 2000, "opens": 500, "clicks": 80, ...}]}

Получите статистику кампании с разбивкой по домену получателя (gmail.com, outlook.com и т.д.). Используйте, чтобы выявить проблемы с доставляемостью у конкретных провайдеров или сравнить вовлечённость по доменам. Для общих агрегированных метрик используйте get_campaign_report. Работает только для отправленных кампаний. Аргументы: campaign_id: ID кампании в Mailchimp (например 'abc123def4'). Обязательно отправленная кампания. Возвращает: JSON с total_items и массивом domains. Каждый domain: domain (строка, например 'gmail.com'), emails_sent (целое), bounces (целое), opens (целое), clicks (целое), unsubs (целое). Пример: get_domain_performance(campaign_id="abc123") -> {"total_items": 15, "domains": [{"domain": "gmail.com", "emails_sent": 2000, "opens": 500, "clicks": 80, ...}]}

Параметры

  • campaign_idstringобязательный
  • accountany
get_ecommerce_product_activityтолько чтение

Получает активность товаров в e-commerce для кампании с разбивкой по выручке на товар. Требуется активная интеграция e-commerce; если интеграция не подключена, возвращает total_items: 0. Используйте list_ecommerce_stores, чтобы проверить статус. Работает только для отправленных кампаний. Возвращает ошибку 404, если campaign_id недействителен. Аргументы: campaign_id: ID кампании (например 'abc123def4'). Должна быть отправленной кампанией. count: Количество товаров для возврата (1-1000, по умолчанию 20). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом products. Каждый элемент: title, sku, image_url, total_revenue (число с плавающей точкой, в валюте магазина), total_purchased.

Получает активность товаров в e-commerce для кампании с разбивкой по выручке на товар. Требуется активная интеграция e-commerce; если интеграция не подключена, возвращает total_items: 0. Используйте list_ecommerce_stores, чтобы проверить статус. Работает только для отправленных кампаний. Возвращает ошибку 404, если campaign_id недействителен. Аргументы: campaign_id: ID кампании (например 'abc123def4'). Должна быть отправленной кампанией. count: Количество товаров для возврата (1-1000, по умолчанию 20). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом products. Каждый элемент: title, sku, image_url, total_revenue (число с плавающей точкой, в валюте магазина), total_purchased.

Параметры

  • campaign_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
get_eepurl_activityтолько чтение

Получает статистику публикаций в соцсетях для eepurl кампании (короткая ссылка Mailchimp). Используется, чтобы измерить, сколько раз кампанию поделились в Twitter/Facebook и других соцсетях через ссылку «Поделиться», которую генерирует Mailchimp. Для подсчёта кликов по ссылкам внутри письма используйте get_campaign_click_details. Работает только для отправленных кампаний, у которых включено отслеживание eepurl. Аргументы: campaign_id: идентификатор кампании Mailchimp (например, 'abc123def4'). Должна быть отправленная кампания. Возвращает: JSON с полями: eepurl (короткая ссылка), twitter (объект с полями statuses, first_status, last_status, replies, impressions, retweets), facebook (объект с полями likes, recipient_likes, unique_likes), referrers (массив объектов {referrer, clicks, first_click, last_click}).

Получает статистику публикаций в соцсетях для eepurl кампании (короткая ссылка Mailchimp). Используется, чтобы измерить, сколько раз кампанию поделились в Twitter/Facebook и других соцсетях через ссылку «Поделиться», которую генерирует Mailchimp. Для подсчёта кликов по ссылкам внутри письма используйте get_campaign_click_details. Работает только для отправленных кампаний, у которых включено отслеживание eepurl. Аргументы: campaign_id: идентификатор кампании Mailchimp (например, 'abc123def4'). Должна быть отправленная кампания. Возвращает: JSON с полями: eepurl (короткая ссылка), twitter (объект с полями statuses, first_status, last_status, replies, impressions, retweets), facebook (объект с полями likes, recipient_likes, unique_likes), referrers (массив объектов {referrer, clicks, first_click, last_click}).

Параметры

  • campaign_idstringобязательный
  • accountany
get_email_activityтолько чтение

Получить временную шкалу активности для каждого получателя отправленной кампании (открытия, клики, отказы). Используйте get_open_details только для данных об открытиях. Используйте get_campaign_report для общих сумм. Используйте get_campaign_recipients только для статуса доставки. Аргументы: campaign_id: идентификатор кампании (например, 'abc123def4'). Должна быть отправленная кампания. count: количество записей получателей для возврата (1–1000, по умолчанию 20). offset: смещение для постраничного вывода. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом emails. Каждый элемент: email_address, массив activity с действием ('open'/'click'/'bounce'), timestamp, url (только для кликов).

Получить временную шкалу активности для каждого получателя отправленной кампании (открытия, клики, отказы). Используйте get_open_details только для данных об открытиях. Используйте get_campaign_report для общих сумм. Используйте get_campaign_recipients только для статуса доставки. Аргументы: campaign_id: идентификатор кампании (например, 'abc123def4'). Должна быть отправленная кампания. count: количество записей получателей для возврата (1–1000, по умолчанию 20). offset: смещение для постраничного вывода. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом emails. Каждый элемент: email_address, массив activity с действием ('open'/'click'/'bounce'), timestamp, url (только для кликов).

Параметры

  • campaign_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
get_fileтолько чтение

Получает полные метаданные одного файла File Manager. Используйте, когда у вас есть file_id (из list_files) и нужен его публичный URL, размеры или папка. list_files поможет просмотреть файлы и найти их file_id. Возвращает ошибку 404, если file_id некорректен. Аргументы: file_id - идентификатор файла (числовой, в виде строки) из list_files. Возвращает: JSON с полями id, name, type, full_size_url, thumbnail_url, size, width, height, folder_id, created_at, created_by.

Получает полные метаданные одного файла File Manager. Используйте, когда у вас есть file_id (из list_files) и нужен его публичный URL, размеры или папка. list_files поможет просмотреть файлы и найти их file_id. Возвращает ошибку 404, если file_id некорректен. Аргументы: file_id - идентификатор файла (числовой, в виде строки) из list_files. Возвращает: JSON с полями id, name, type, full_size_url, thumbnail_url, size, width, height, folder_id, created_at, created_by.

Параметры

  • file_idstringобязательный
  • accountany
get_landing_pageтолько чтение

Извлекает полные сведения о целевой странице, включая описание и настройки отслеживания. Для просмотра всех страниц и получения их идентификаторов используйте list_landing_pages. Возвращает ошибку 404, если page_id указан неверно. Аргументы: page_id — идентификатор целевой страницы (буквенно-цифровая строка). Берётся из list_landing_pages. Возвращает: JSON с полями: id, name, title, description, status (возможные значения: "published", "unpublished", "draft"), url, published_at, created_at, updated_at, list_id, tracking.

Извлекает полные сведения о целевой странице, включая описание и настройки отслеживания. Для просмотра всех страниц и получения их идентификаторов используйте list_landing_pages. Возвращает ошибку 404, если page_id указан неверно. Аргументы: page_id — идентификатор целевой страницы (буквенно-цифровая строка). Берётся из list_landing_pages. Возвращает: JSON с полями: id, name, title, description, status (возможные значения: "published", "unpublished", "draft"), url, published_at, created_at, updated_at, list_id, tracking.

Параметры

  • page_idstringобязательный
  • accountany
get_landing_page_reportтолько чтение

Получает отчёт для одной целевой страницы. Получает подробный отчёт о производительности для одной целевой страницы, определяемой по её outreach id. Используйте это для просмотра посещений, конверсий и других метрик для конкретной страницы. Аргументы: outreach_id: Идентификатор outreach целевой страницы, по которой составляется отчёт. Возвращает: JSON с отчётом по целевой странице.

Получает отчёт для одной целевой страницы. Получает подробный отчёт о производительности для одной целевой страницы, определяемой по её outreach id. Используйте это для просмотра посещений, конверсий и других метрик для конкретной страницы. Аргументы: outreach_id: Идентификатор outreach целевой страницы, по которой составляется отчёт. Возвращает: JSON с отчётом по целевой странице.

Параметры

  • outreach_idstringобязательный
  • accountany
get_member_activityтолько чтение

Получает историю взаимодействия участника с email (открытия, переходы, отказы по всем кампаниям). Показывает только действия с email. Для пользовательских событий, инициированных через API, используйте get_member_events. Для данных тегов используйте get_member_tags. Сначала используйте search_members, чтобы узнать, к какой аудитории относится участник. Возвращает ошибку 404, если участник не существует в аудитории. Аргументы: list_id: ID аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. email_address: Email участника. Должен существовать в аудитории. count: Количество записей активности для возврата (1-1000, по умолчанию 20). Возвращает: JSON с email_address и массивом activity. Каждый элемент: action ('open'/'click'/'bounce'), timestamp, campaign_id, title.

Получает историю взаимодействия участника с email (открытия, переходы, отказы по всем кампаниям). Показывает только действия с email. Для пользовательских событий, инициированных через API, используйте get_member_events. Для данных тегов используйте get_member_tags. Сначала используйте search_members, чтобы узнать, к какой аудитории относится участник. Возвращает ошибку 404, если участник не существует в аудитории. Аргументы: list_id: ID аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. email_address: Email участника. Должен существовать в аудитории. count: Количество записей активности для возврата (1-1000, по умолчанию 20). Возвращает: JSON с email_address и массивом activity. Каждый элемент: action ('open'/'click'/'bounce'), timestamp, campaign_id, title.

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • countinteger
  • accountany
get_member_eventsтолько чтение

Получает кастомные события, вызванные через API, для конкретного участника (например, «purchased», «signed_up»). Используйте, чтобы просмотреть события, отправленные в Mailchimp через Events API. Это кастомные события приложения, а не взаимодействия с письмами (открытия, клики) — для данных о вовлеченности в письмах используйте get_member_activity. Возвращает пустой результат, если для участника не записано ни одного кастомного события. Аргументы: list_id: ID аудитории/списка Mailchimp (например, 'abc123def4'). Получить из list_audiences. email_address: Email-адрес участника. Должен существовать в аудитории. count: Количество возвращаемых событий (1–1000, по умолчанию 20). Возвращает: JSON с email_address, total_items (int) и массивом events. Каждое событие: name (строка, имя события), occurred_at (ISO 8601), properties (объект, кастомные данные в формате ключ-значение или null). Пример: get_member_events(list_id="abc123", email_address="jane@co.com") -> {"email_address": "jane@co.com", "total_items": 5, "events": [{"name": "purchased", "occurred_at": "2025-06-01T10:00:00Z", "properties": {"product": "T-Shirt"}}]}

Получает кастомные события, вызванные через API, для конкретного участника (например, «purchased», «signed_up»). Используйте, чтобы просмотреть события, отправленные в Mailchimp через Events API. Это кастомные события приложения, а не взаимодействия с письмами (открытия, клики) — для данных о вовлеченности в письмах используйте get_member_activity. Возвращает пустой результат, если для участника не записано ни одного кастомного события. Аргументы: list_id: ID аудитории/списка Mailchimp (например, 'abc123def4'). Получить из list_audiences. email_address: Email-адрес участника. Должен существовать в аудитории. count: Количество возвращаемых событий (1–1000, по умолчанию 20). Возвращает: JSON с email_address, total_items (int) и массивом events. Каждое событие: name (строка, имя события), occurred_at (ISO 8601), properties (объект, кастомные данные в формате ключ-значение или null). Пример: get_member_events(list_id="abc123", email_address="jane@co.com") -> {"email_address": "jane@co.com", "total_items": 5, "events": [{"name": "purchased", "occurred_at": "2025-06-01T10:00:00Z", "properties": {"product": "T-Shirt"}}]}

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • countinteger
  • accountany
get_member_goalsтолько чтение

Получает последние 50 событий Goal, вызванных определённым участником аудитории. Используйте, чтобы увидеть, какие отслеживаемые цели сайта (конверсионные события на основе URL) достиг участник. Для более широкой активности по email используйте `get_member_activity`, или сначала найдите участника через `search_members`. Параметры: list_id: ID аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получить из `list_audiences`. email_address: Email участника. Хэш подписчика вычисляется автоматически. Результат: JSON с полями total_items и goals (массив). Каждый элемент: goal_id, event (отслеживаемое значение), last_visited_at (ISO 8601), data (URL или данные события). Возвращает ошибку, если участник не найден.

Получает последние 50 событий Goal, вызванных определённым участником аудитории. Используйте, чтобы увидеть, какие отслеживаемые цели сайта (конверсионные события на основе URL) достиг участник. Для более широкой активности по email используйте `get_member_activity`, или сначала найдите участника через `search_members`. Параметры: list_id: ID аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получить из `list_audiences`. email_address: Email участника. Хэш подписчика вычисляется автоматически. Результат: JSON с полями total_items и goals (массив). Каждый элемент: goal_id, event (отслеживаемое значение), last_visited_at (ISO 8601), data (URL или данные события). Возвращает ошибку, если участник не найден.

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • accountany
get_member_journey_eventsтолько чтение

Извлекает события активности участника, отфильтрованные по действиям, связанным с автоматизациями и джорни. Возвращает подмножество ленты активности участника, которое относится к Classic Automations и (там, где Mailchimp их показывает) письмам Customer Journey. Помогает ответить на вопрос «какие письма автоматизаций или джорни получил этот контакт?» без просмотра всей его активности. Примечание: Mailchimp не предоставляет публичного read API для самих Customer Journeys. Письма джорни появляются в ленте активности как действия с типом автоматизации, поэтому этот инструмент извлекает их через этот побочный канал, а не напрямую из графа джорни. Используйте trigger_customer_journey, чтобы записать контакт на конкретный шаг джорни (единственная операция записи для джорни, доступная через API). Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой код). Получить из list_audiences. email_address: Email участника. Должен существовать в аудитории. count: Количество строк активности для сканирования перед фильтрацией (1-1000, по умолчанию 50). Увеличьте, если участник очень активен и вы подозреваете, что события автоматизаций пропускаются. Возвращает: JSON с полями email_address, scanned (количество просмотренных сырых строк), total_journey_events (после фильтрации) и events (массив). Каждое событие: action (сырой тип действия), timestamp, title (название кампании/автоматизации, если есть), url (ссылка, по которой кликнули, если есть), campaign_id.

Извлекает события активности участника, отфильтрованные по действиям, связанным с автоматизациями и джорни. Возвращает подмножество ленты активности участника, которое относится к Classic Automations и (там, где Mailchimp их показывает) письмам Customer Journey. Помогает ответить на вопрос «какие письма автоматизаций или джорни получил этот контакт?» без просмотра всей его активности. Примечание: Mailchimp не предоставляет публичного read API для самих Customer Journeys. Письма джорни появляются в ленте активности как действия с типом автоматизации, поэтому этот инструмент извлекает их через этот побочный канал, а не напрямую из графа джорни. Используйте trigger_customer_journey, чтобы записать контакт на конкретный шаг джорни (единственная операция записи для джорни, доступная через API). Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой код). Получить из list_audiences. email_address: Email участника. Должен существовать в аудитории. count: Количество строк активности для сканирования перед фильтрацией (1-1000, по умолчанию 50). Увеличьте, если участник очень активен и вы подозреваете, что события автоматизаций пропускаются. Возвращает: JSON с полями email_address, scanned (количество просмотренных сырых строк), total_journey_events (после фильтрации) и events (массив). Каждое событие: action (сырой тип действия), timestamp, title (название кампании/автоматизации, если есть), url (ссылка, по которой кликнули, если есть), campaign_id.

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • countinteger
  • accountany
get_member_tagsтолько чтение

Получить все теги, назначенные конкретному участнику. Используйте, чтобы посмотреть, какие теги есть у участника, прежде чем их менять. Для добавления или удаления тегов используйте tag_member. Чтобы увидеть все доступные теги/сегменты в аудитории, используйте list_segments. Аргументы: list_id: Идентификатор аудитории/списка Mailchimp (например, 'abc123def4'). Получить из list_audiences. email_address: Email участника. Должен существовать в аудитории. count: Количество возвращаемых тегов (1-1000, по умолчанию 50). Возвращает: JSON с полями email_address, total_items (int) и массивом tags. Каждый тег: id (int), name (string), date_added (ISO 8601). Пример: get_member_tags(list_id="abc123", email_address="jane@co.com") -> {"email_address": "jane@co.com", "total_items": 3, "tags": [{"name": "VIP", "date_added": "2025-01-15T10:00:00Z", ...}]}

Получить все теги, назначенные конкретному участнику. Используйте, чтобы посмотреть, какие теги есть у участника, прежде чем их менять. Для добавления или удаления тегов используйте tag_member. Чтобы увидеть все доступные теги/сегменты в аудитории, используйте list_segments. Аргументы: list_id: Идентификатор аудитории/списка Mailchimp (например, 'abc123def4'). Получить из list_audiences. email_address: Email участника. Должен существовать в аудитории. count: Количество возвращаемых тегов (1-1000, по умолчанию 50). Возвращает: JSON с полями email_address, total_items (int) и массивом tags. Каждый тег: id (int), name (string), date_added (ISO 8601). Пример: get_member_tags(list_id="abc123", email_address="jane@co.com") -> {"email_address": "jane@co.com", "total_items": 3, "tags": [{"name": "VIP", "date_added": "2025-01-15T10:00:00Z", ...}]}

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • countinteger
  • accountany
get_open_detailsтолько чтение

Получить данные об открытиях для каждого получателя отправленной кампании (кто открыл, когда, сколько раз). Используйте get_campaign_report для сводных показателей открытий. Используйте get_email_activity для всех типов активности вместе. Аргументы: campaign_id: идентификатор кампании (например, 'abc123def4'). Должна быть отправленной кампанией. count: количество записей для возврата (1-1000, по умолчанию 20). offset: смещение для пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом members. Каждый элемент: email_address, opens_count, opens с массивом временных меток.

Получить данные об открытиях для каждого получателя отправленной кампании (кто открыл, когда, сколько раз). Используйте get_campaign_report для сводных показателей открытий. Используйте get_email_activity для всех типов активности вместе. Аргументы: campaign_id: идентификатор кампании (например, 'abc123def4'). Должна быть отправленной кампанией. count: количество записей для возврата (1-1000, по умолчанию 20). offset: смещение для пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом members. Каждый элемент: email_address, opens_count, opens с массивом временных меток.

Параметры

  • campaign_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
get_promo_codeтолько чтение

Получает один промокод по ID вместе с его текущими настройками и статистикой использования. Используйте, чтобы проверить usage_count кода перед кампанией или подтвердить, что код включён. Используйте list_promo_codes для просмотра кодов для правила. Возвращает 404, если хотя бы один из store_id, promo_rule_id или promo_code_id неверен. Аргументы: store_id: ID интернет-магазина. promo_rule_id: ID правила, к которому привязан код. promo_code_id: ID кода для проверки. Возвращает: JSON с полями id, code, redemption_url, usage_count, enabled, created_at, updated_at.

Получает один промокод по ID вместе с его текущими настройками и статистикой использования. Используйте, чтобы проверить usage_count кода перед кампанией или подтвердить, что код включён. Используйте list_promo_codes для просмотра кодов для правила. Возвращает 404, если хотя бы один из store_id, promo_rule_id или promo_code_id неверен. Аргументы: store_id: ID интернет-магазина. promo_rule_id: ID правила, к которому привязан код. promo_code_id: ID кода для проверки. Возвращает: JSON с полями id, code, redemption_url, usage_count, enabled, created_at, updated_at.

Параметры

  • store_idstringобязательный
  • promo_rule_idstringобязательный
  • promo_code_idstringобязательный
  • accountany
get_promo_ruleтолько чтение

Получить одно промо-правило по ID с полной конфигурацией. Используйте, чтобы проверить текущие настройки правила перед обновлением или подтвердить, что правило существует, прежде чем прикреплять новые коды. Используйте list_promo_rules для просмотра и поиска ID. Возвращает 404, если store_id или promo_rule_id недействительны. Аргументы: store_id: ID магазина электронной коммерции. promo_rule_id: ID правила для проверки. Возвращает: JSON с полями id, title, description, amount, type, target, enabled, starts_at, ends_at, created_at, updated_at.

Получить одно промо-правило по ID с полной конфигурацией. Используйте, чтобы проверить текущие настройки правила перед обновлением или подтвердить, что правило существует, прежде чем прикреплять новые коды. Используйте list_promo_rules для просмотра и поиска ID. Возвращает 404, если store_id или promo_rule_id недействительны. Аргументы: store_id: ID магазина электронной коммерции. promo_rule_id: ID правила для проверки. Возвращает: JSON с полями id, title, description, amount, type, target, enabled, starts_at, ends_at, created_at, updated_at.

Параметры

  • store_idstringобязательный
  • promo_rule_idstringобязательный
  • accountany
get_segmentтолько чтение

Получает полные данные о конкретном сегменте: количество участников и условия фильтрации. Используйте, чтобы проверить условия сегмента, убедиться в его типе и количестве участников. Для просмотра всех сегментов используйте list_segments. Чтобы посмотреть отдельных участников сегмента — list_segment_members. Аргументы: list_id: идентификатор аудитории/списка Mailchimp (например 'abc123def4'). Получить из list_audiences. segment_id: идентификатор сегмента (строка с цифрами, например '12345'). Получить из list_segments. Возвращает: JSON с полями: id, name, member_count (целое число), type ('static' для тегов, 'saved' для динамических сегментов), created_at (ISO 8601), updated_at (ISO 8601), options (объект с полями match и conditions для динамических сегментов, null для статических). Пример: get_segment(list_id="abc123", segment_id="12345") -> {"id": 12345, "name": "VIP", "member_count": 150, "type": "static", ...}

Получает полные данные о конкретном сегменте: количество участников и условия фильтрации. Используйте, чтобы проверить условия сегмента, убедиться в его типе и количестве участников. Для просмотра всех сегментов используйте list_segments. Чтобы посмотреть отдельных участников сегмента — list_segment_members. Аргументы: list_id: идентификатор аудитории/списка Mailchimp (например 'abc123def4'). Получить из list_audiences. segment_id: идентификатор сегмента (строка с цифрами, например '12345'). Получить из list_segments. Возвращает: JSON с полями: id, name, member_count (целое число), type ('static' для тегов, 'saved' для динамических сегментов), created_at (ISO 8601), updated_at (ISO 8601), options (объект с полями match и conditions для динамических сегментов, null для статических). Пример: get_segment(list_id="abc123", segment_id="12345") -> {"id": 12345, "name": "VIP", "member_count": 150, "type": "static", ...}

Параметры

  • list_idstringобязательный
  • segment_idstringобязательный
  • accountany
get_storeтолько чтение

Получает один интернет-магазин с его конфигурацией и данными подключения. Просматривает валюту магазина, подключенную аудиторию и статус синхронизации. Для просмотра и поиска store_id используйте list_ecommerce_stores. Аргументы: store_id: Идентификатор интернет-магазина. Получается из list_ecommerce_stores. Возвращает: JSON с объектом магазина.

Получает один интернет-магазин с его конфигурацией и данными подключения. Просматривает валюту магазина, подключенную аудиторию и статус синхронизации. Для просмотра и поиска store_id используйте list_ecommerce_stores. Аргументы: store_id: Идентификатор интернет-магазина. Получается из list_ecommerce_stores. Возвращает: JSON с объектом магазина.

Параметры

  • store_idstringобязательный
  • accountany
get_store_cartтолько чтение

Получает одну корзину со всеми позициями, покупателем и детальной разбивкой суммы. Используйте для просмотра содержимого брошенной корзины перед отправкой письма для восстановления. Чтобы найти cart_id, вызовите list_store_carts. Возвращает 404, если store_id или cart_id некорректны. Аргументы: store_id: ID магазина электронной коммерции. Получить через list_ecommerce_stores. cart_id: ID корзины. Получить через list_store_carts. Возвращает: JSON с полями id, customer, currency_code, order_total, tax_total, checkout_url, lines (массив объектов {id, product_id, product_variant_id, quantity, price}), created_at, updated_at.

Получает одну корзину со всеми позициями, покупателем и детальной разбивкой суммы. Используйте для просмотра содержимого брошенной корзины перед отправкой письма для восстановления. Чтобы найти cart_id, вызовите list_store_carts. Возвращает 404, если store_id или cart_id некорректны. Аргументы: store_id: ID магазина электронной коммерции. Получить через list_ecommerce_stores. cart_id: ID корзины. Получить через list_store_carts. Возвращает: JSON с полями id, customer, currency_code, order_total, tax_total, checkout_url, lines (массив объектов {id, product_id, product_variant_id, quantity, price}), created_at, updated_at.

Параметры

  • store_idstringобязательный
  • cart_idstringобязательный
  • accountany
get_store_customerтолько чтение

Получает одного покупателя магазина с его email, статусом opt-in и суммами заказов. Используйте для просмотра истории покупок и состояния подписки клиента. Используйте list_store_customers для просмотра и поиска customer_ids. Аргументы: store_id: Идентификатор интернет-магазина. customer_id: Идентификатор клиента. Получите из list_store_customers. Возвращает: JSON с объектом клиента.

Получает одного покупателя магазина с его email, статусом opt-in и суммами заказов. Используйте для просмотра истории покупок и состояния подписки клиента. Используйте list_store_customers для просмотра и поиска customer_ids. Аргументы: store_id: Идентификатор интернет-магазина. customer_id: Идентификатор клиента. Получите из list_store_customers. Возвращает: JSON с объектом клиента.

Параметры

  • store_idstringобязательный
  • customer_idstringобязательный
  • accountany
get_store_orderтолько чтение

Получает один заказ электронной коммерции с его позициями, покупателем и итоговыми суммами. Позволяет просмотреть полные детали одного заказа после его поиска через list_store_orders или list_account_orders. Ручное создание заказов подходит для кастомных или headless магазинов; интеграции с Shopify и WooCommerce синхронизируют заказы автоматически. Аргументы: store_id: Идентификатор магазина электронной коммерции. Получается из list_ecommerce_stores. order_id: Идентификатор заказа внутри магазина. Получается из list_store_orders. Возвращает: JSON с полным объектом заказа (id, customer, currency_code, order_total, lines, financial_status, processed_at_foreign и связанные поля).

Получает один заказ электронной коммерции с его позициями, покупателем и итоговыми суммами. Позволяет просмотреть полные детали одного заказа после его поиска через list_store_orders или list_account_orders. Ручное создание заказов подходит для кастомных или headless магазинов; интеграции с Shopify и WooCommerce синхронизируют заказы автоматически. Аргументы: store_id: Идентификатор магазина электронной коммерции. Получается из list_ecommerce_stores. order_id: Идентификатор заказа внутри магазина. Получается из list_store_orders. Возвращает: JSON с полным объектом заказа (id, customer, currency_code, order_total, lines, financial_status, processed_at_foreign и связанные поля).

Параметры

  • store_idstringобязательный
  • order_idstringобязательный
  • accountany
get_store_order_lineтолько чтение

Извлекает одну позицию заказа e-commerce. Используется для просмотра количества, цены и скидки одного товара в заказе. Manual commerce подходит для кастомных и headless магазинов; интеграции с Shopify и WooCommerce синхронизируют строки заказов автоматически. Аргументы: store_id: Идентификатор магазина e-commerce. Получите из list_ecommerce_stores. order_id: Идентификатор заказа, которому принадлежит позиция. line_id: Идентификатор позиции. Получите из list_store_order_lines. Возвращает: JSON с объектом позиции (id, product_id, product_variant_id, quantity, price, discount).

Извлекает одну позицию заказа e-commerce. Используется для просмотра количества, цены и скидки одного товара в заказе. Manual commerce подходит для кастомных и headless магазинов; интеграции с Shopify и WooCommerce синхронизируют строки заказов автоматически. Аргументы: store_id: Идентификатор магазина e-commerce. Получите из list_ecommerce_stores. order_id: Идентификатор заказа, которому принадлежит позиция. line_id: Идентификатор позиции. Получите из list_store_order_lines. Возвращает: JSON с объектом позиции (id, product_id, product_variant_id, quantity, price, discount).

Параметры

  • store_idstringобязательный
  • order_idstringобязательный
  • line_idstringобязательный
  • accountany
get_store_productтолько чтение

Получает один товар из магазина вместе с его вариантами и деталями. Просматривает название товара, варианты, изображения и цены. Используйте list_store_products для просмотра и поиска product_id. Аргументы: store_id: Идентификатор магазина электронной коммерции. Получите из list_ecommerce_stores. product_id: Идентификатор товара. Получите из list_store_products. Возвращает: JSON с объектом товара, включающим массив его вариантов.

Получает один товар из магазина вместе с его вариантами и деталями. Просматривает название товара, варианты, изображения и цены. Используйте list_store_products для просмотра и поиска product_id. Аргументы: store_id: Идентификатор магазина электронной коммерции. Получите из list_ecommerce_stores. product_id: Идентификатор товара. Получите из list_store_products. Возвращает: JSON с объектом товара, включающим массив его вариантов.

Параметры

  • store_idstringобязательный
  • product_idstringобязательный
  • accountany
get_store_product_imageтолько чтение

Извлекает одно изображение, прикреплённое к товару в интернет-магазине. Просматривает URL одного изображения и связи с вариантами. Подходит для кастомных/безголовых магазинов с ручным управлением; интеграции с Shopify и WooCommerce синхронизируют изображения товаров автоматически. Аргументы: store_id: ID интернет-магазина. Получить из list_ecommerce_stores. product_id: ID товара, которому принадлежит изображение. image_id: ID изображения. Получить из list_store_product_images. Возвращает: JSON с объектом изображения (id, url, variant_ids).

Извлекает одно изображение, прикреплённое к товару в интернет-магазине. Просматривает URL одного изображения и связи с вариантами. Подходит для кастомных/безголовых магазинов с ручным управлением; интеграции с Shopify и WooCommerce синхронизируют изображения товаров автоматически. Аргументы: store_id: ID интернет-магазина. Получить из list_ecommerce_stores. product_id: ID товара, которому принадлежит изображение. image_id: ID изображения. Получить из list_store_product_images. Возвращает: JSON с объектом изображения (id, url, variant_ids).

Параметры

  • store_idstringобязательный
  • product_idstringобязательный
  • image_idstringобязательный
  • accountany
get_store_product_variantтолько чтение

Получает один вариант товара с его ценой, SKU и данными о запасах. Используйте для просмотра атрибутов одного варианта. Используйте list_store_product_variants для просмотра и поиска variant_ids. Аргументы: store_id: Идентификатор магазина электронной коммерции. product_id: Идентификатор товара, которому принадлежит вариант. variant_id: Идентификатор варианта. Получите из list_store_product_variants. Возвращает: JSON с объектом варианта.

Получает один вариант товара с его ценой, SKU и данными о запасах. Используйте для просмотра атрибутов одного варианта. Используйте list_store_product_variants для просмотра и поиска variant_ids. Аргументы: store_id: Идентификатор магазина электронной коммерции. product_id: Идентификатор товара, которому принадлежит вариант. variant_id: Идентификатор варианта. Получите из list_store_product_variants. Возвращает: JSON с объектом варианта.

Параметры

  • store_idstringобязательный
  • product_idstringобязательный
  • variant_idstringобязательный
  • accountany
get_surveyтолько чтение

Получить полные данные по одному опросу. Используйте, когда у вас есть survey_id (из list_surveys) и нужны его вопросы, статус или публичная ссылка. Чтобы изменить, опубликован опрос или нет, используйте publish_survey / unpublish_survey. Возвращает ошибку 404, если list_id или survey_id недействителен. Аргументы: list_id: ID аудитории/списка (из list_audiences). survey_id: ID опроса (из list_surveys). Возвращает: JSON-объект опроса, включающий id, title, status, url, questions, created_at, updated_at.

Получить полные данные по одному опросу. Используйте, когда у вас есть survey_id (из list_surveys) и нужны его вопросы, статус или публичная ссылка. Чтобы изменить, опубликован опрос или нет, используйте publish_survey / unpublish_survey. Возвращает ошибку 404, если list_id или survey_id недействителен. Аргументы: list_id: ID аудитории/списка (из list_audiences). survey_id: ID опроса (из list_surveys). Возвращает: JSON-объект опроса, включающий id, title, status, url, questions, created_at, updated_at.

Параметры

  • list_idstringобязательный
  • survey_idstringобязательный
  • accountany
get_survey_question_answersтолько чтение

Выводит ответы на один вопрос опроса. Получает отдельные ответы, отправленные для одного конкретного вопроса в указанном опросе. Используйте count и offset для постраничного вывода больших наборов результатов. Аргументы: survey_id: Уникальный идентификатор опроса. question_id: Уникальный идентификатор вопроса, ответы на который нужно вывести. count: Количество записей, возвращаемых на одной странице (по умолчанию 10). offset: Количество записей, пропускаемых для постраничного вывода (по умолчанию 0). Возвращает: JSON со списком ответов на вопрос опроса.

Выводит ответы на один вопрос опроса. Получает отдельные ответы, отправленные для одного конкретного вопроса в указанном опросе. Используйте count и offset для постраничного вывода больших наборов результатов. Аргументы: survey_id: Уникальный идентификатор опроса. question_id: Уникальный идентификатор вопроса, ответы на который нужно вывести. count: Количество записей, возвращаемых на одной странице (по умолчанию 10). offset: Количество записей, пропускаемых для постраничного вывода (по умолчанию 0). Возвращает: JSON со списком ответов на вопрос опроса.

Параметры

  • survey_idstringобязательный
  • question_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
get_survey_questions_reportтолько чтение

Получает отчёт по вопросам для одного опроса. Извлекает сводный отчёт с разбивкой по каждому вопросу в указанном опросе. Используйте это, чтобы понять, как респонденты отвечали на все вопросы. Аргументы: survey_id: Уникальный идентификатор опроса, по вопросам которого составляется отчёт. Возвращает: JSON с отчётом по вопросам опроса.

Получает отчёт по вопросам для одного опроса. Извлекает сводный отчёт с разбивкой по каждому вопросу в указанном опросе. Используйте это, чтобы понять, как респонденты отвечали на все вопросы. Аргументы: survey_id: Уникальный идентификатор опроса, по вопросам которого составляется отчёт. Возвращает: JSON с отчётом по вопросам опроса.

Параметры

  • survey_idstringобязательный
  • accountany
get_survey_reportтолько чтение

Получает отчёт для одного опроса. Извлекает подробный отчёт о производительности для одного опроса по его идентификатору. Используйте это, чтобы просмотреть коэффициенты ответов и вовлечённость для конкретного опроса. Аргументы: survey_id: Уникальный идентификатор опроса, для которого составляется отчёт. Возвращает: JSON с отчётом по опросу.

Получает отчёт для одного опроса. Извлекает подробный отчёт о производительности для одного опроса по его идентификатору. Используйте это, чтобы просмотреть коэффициенты ответов и вовлечённость для конкретного опроса. Аргументы: survey_id: Уникальный идентификатор опроса, для которого составляется отчёт. Возвращает: JSON с отчётом по опросу.

Параметры

  • survey_idstringобязательный
  • accountany
get_survey_responseтолько чтение

Получает один ответ опроса. Извлекает детали одного конкретного ответа, отправленного в указанный опрос. Используйте это, чтобы просмотреть ответы отдельного респондента. Args: survey_id: Уникальный идентификатор опроса. response_id: Уникальный идентификатор запрашиваемого ответа. Returns: JSON с деталями ответа опроса.

Получает один ответ опроса. Извлекает детали одного конкретного ответа, отправленного в указанный опрос. Используйте это, чтобы просмотреть ответы отдельного респондента. Args: survey_id: Уникальный идентификатор опроса. response_id: Уникальный идентификатор запрашиваемого ответа. Returns: JSON с деталями ответа опроса.

Параметры

  • survey_idstringобязательный
  • response_idstringобязательный
  • accountany
get_survey_responsesтолько чтение

Выводит список ответов для одного опроса. Получает отдельные ответы, отправленные в указанный опрос. Используйте count и offset для разбивки больших наборов результатов на страницы. Аргументы: survey_id: Уникальный идентификатор опроса, ответы на который нужно вывести. count: Количество записей, возвращаемых на одной странице (по умолчанию 10). offset: Количество записей, пропускаемых для пагинации (по умолчанию 0). Возвращает: JSON со списком ответов на опрос.

Выводит список ответов для одного опроса. Получает отдельные ответы, отправленные в указанный опрос. Используйте count и offset для разбивки больших наборов результатов на страницы. Аргументы: survey_id: Уникальный идентификатор опроса, ответы на который нужно вывести. count: Количество записей, возвращаемых на одной странице (по умолчанию 10). offset: Количество записей, пропускаемых для пагинации (по умолчанию 0). Возвращает: JSON со списком ответов на опрос.

Параметры

  • survey_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
get_templateтолько чтение

Получает метаданные шаблона (название, тип, даты, папка, миниатюра) без его HTML-содержимого. Используйте, чтобы проверить настройки шаблона или убедиться, что он существует, прежде чем ссылаться на него в другом месте. Используйте get_template_default_content для получения актуального HTML-тела. Используйте list_templates для просмотра и поиска идентификаторов шаблонов. Возвращает ошибку 404, если template_id недействителен. Аргументы: template_id: Идентификатор шаблона (числовая строка, например '12345'). Получить из list_templates. Возвращает: JSON с id, name, type ('user' | 'base' | 'gallery'), drag_and_drop (bool), date_created, date_edited, created_by, edited_by, active (bool), folder_id, thumbnail, share_url, category.

Получает метаданные шаблона (название, тип, даты, папка, миниатюра) без его HTML-содержимого. Используйте, чтобы проверить настройки шаблона или убедиться, что он существует, прежде чем ссылаться на него в другом месте. Используйте get_template_default_content для получения актуального HTML-тела. Используйте list_templates для просмотра и поиска идентификаторов шаблонов. Возвращает ошибку 404, если template_id недействителен. Аргументы: template_id: Идентификатор шаблона (числовая строка, например '12345'). Получить из list_templates. Возвращает: JSON с id, name, type ('user' | 'base' | 'gallery'), drag_and_drop (bool), date_created, date_edited, created_by, edited_by, active (bool), folder_id, thumbnail, share_url, category.

Параметры

  • template_idstringобязательный
  • accountany
get_template_default_contentтолько чтение

Извлекает HTML-содержимое шаблона по умолчанию для использования в контентах кампании. Используйте для извлечения HTML шаблона перед его настройкой с помощью set_campaign_content. Работает только с шаблонами, созданными пользователем; шаблоны из галереи могут возвращать ограниченное содержимое. Используйте list_templates, чтобы найти ID шаблонов. Возвращает ошибку 404, если template_id недействителен. Аргументы: template_id: ID шаблона (строка цифр, напр. '12345'). Получить из list_templates. Возвращает: JSON с полями: html (строка, полное HTML-содержимое), sections (объект с редактируемыми блоками контента).

Извлекает HTML-содержимое шаблона по умолчанию для использования в контентах кампании. Используйте для извлечения HTML шаблона перед его настройкой с помощью set_campaign_content. Работает только с шаблонами, созданными пользователем; шаблоны из галереи могут возвращать ограниченное содержимое. Используйте list_templates, чтобы найти ID шаблонов. Возвращает ошибку 404, если template_id недействителен. Аргументы: template_id: ID шаблона (строка цифр, напр. '12345'). Получить из list_templates. Возвращает: JSON с полями: html (строка, полное HTML-содержимое), sections (объект с редактируемыми блоками контента).

Параметры

  • template_idstringобязательный
  • accountany
get_template_folderтолько чтение

Получает детали одной папки с шаблонами. Используйте, чтобы узнать имя папки и сколько шаблонов в ней. Используйте list_template_folders, чтобы найти ID папок. Аргументы: folder_id: ID папки с шаблонами. Получить из list_template_folders. Возвращает: JSON с id, name и количеством шаблонов в папке.

Получает детали одной папки с шаблонами. Используйте, чтобы узнать имя папки и сколько шаблонов в ней. Используйте list_template_folders, чтобы найти ID папок. Аргументы: folder_id: ID папки с шаблонами. Получить из list_template_folders. Возвращает: JSON с id, name и количеством шаблонов в папке.

Параметры

  • folder_idstringобязательный
  • accountany
get_verified_domainтолько чтение

Получает полную запись верификации и аутентификации для одного отправляющего домена. Используйте, когда у вас есть имя домена и нужно узнать его точный статус верификации/аутентификации перед отправкой. Чтобы просмотреть все домены и найти нужные имена, используйте list_verified_domains. Аргументы: domain_name: Отправляющий домен для проверки (например, 'mail.example.com'). Получить из list_verified_domains. Возвращает: JSON с полями domain, verified (boolean), authenticated (boolean), verification_status, authentication_status.

Получает полную запись верификации и аутентификации для одного отправляющего домена. Используйте, когда у вас есть имя домена и нужно узнать его точный статус верификации/аутентификации перед отправкой. Чтобы просмотреть все домены и найти нужные имена, используйте list_verified_domains. Аргументы: domain_name: Отправляющий домен для проверки (например, 'mail.example.com'). Получить из list_verified_domains. Возвращает: JSON с полями domain, verified (boolean), authenticated (boolean), verification_status, authentication_status.

Параметры

  • domain_namestringобязательный
  • accountany
list_account_exportsтолько чтение

Выводит список задач экспорта аккаунта, которые были запрошены для этого аккаунта Mailchimp. Используйте это для отслеживания запросов на экспорт и получения идентификаторов экспорта и их статуса. Используйте get_account_export для полной записи и URL для скачивания отдельного экспорта. Возвращает: JSON с total_items и массивом exports. Каждый экспорт: export_id, status, started (ISO 8601), finished (ISO 8601 или null), size_in_bytes, download_url.

Выводит список задач экспорта аккаунта, которые были запрошены для этого аккаунта Mailchimp. Используйте это для отслеживания запросов на экспорт и получения идентификаторов экспорта и их статуса. Используйте get_account_export для полной записи и URL для скачивания отдельного экспорта. Возвращает: JSON с total_items и массивом exports. Каждый экспорт: export_id, status, started (ISO 8601), finished (ISO 8601 или null), size_in_bytes, download_url.

Параметры

  • accountany
list_account_ordersтолько чтение

Выводит список заказов электронной коммерции по всем магазинам в аккаунте. Используйте для отчётов по заказам в рамках всего аккаунта без перебора магазинов по одному; для одного магазина используйте list_store_orders. Ручные записи коммерции подходят для кастомных/headless-магазинов; интеграции с Shopify и WooCommerce синхронизируют заказы автоматически. Параметры: count: Количество заказов для возврата (максимум 1000). По умолчанию 10. offset: Количество заказов для пропуска при пагинации. По умолчанию 0. Возвращает: JSON с заказами (массив объектов заказов по всем магазинам), total_items.

Выводит список заказов электронной коммерции по всем магазинам в аккаунте. Используйте для отчётов по заказам в рамках всего аккаунта без перебора магазинов по одному; для одного магазина используйте list_store_orders. Ручные записи коммерции подходят для кастомных/headless-магазинов; интеграции с Shopify и WooCommerce синхронизируют заказы автоматически. Параметры: count: Количество заказов для возврата (максимум 1000). По умолчанию 10. offset: Количество заказов для пропуска при пагинации. По умолчанию 0. Возвращает: JSON с заказами (массив объектов заказов по всем магазинам), total_items.

Параметры

  • countinteger
  • offsetinteger
  • accountany
list_accountsтолько чтение

Выводит список аккаунтов Mailchimp, настроенных для использования этим сервером. Используйте это, чтобы узнать имена аккаунтов, которые принимает аргумент `account` во всех остальных инструментах. Поддержка нескольких аккаунтов включается опционально: задавайте дополнительные аккаунты через переменные окружения MAILCHIMP_API_KEY_<NAME>; простая MAILCHIMP_API_KEY — это неявный аккаунт 'default'. Выбор делается для каждого вызова и не сохраняет состояние — ни один инструмент не меняет активный аккаунт. Используйте get_account_info для получения оперативной статистики по конкретному аккаунту. Не требует сетевого вызова. Никогда не возвращает ключи API и никакие секретные данные. Возвращает: JSON c `accounts`: массив из {name, read_only, dry_run, is_default}. Запись 'default' появляется только когда задана MAILCHIMP_API_KEY.

Выводит список аккаунтов Mailchimp, настроенных для использования этим сервером. Используйте это, чтобы узнать имена аккаунтов, которые принимает аргумент `account` во всех остальных инструментах. Поддержка нескольких аккаунтов включается опционально: задавайте дополнительные аккаунты через переменные окружения MAILCHIMP_API_KEY_<NAME>; простая MAILCHIMP_API_KEY — это неявный аккаунт 'default'. Выбор делается для каждого вызова и не сохраняет состояние — ни один инструмент не меняет активный аккаунт. Используйте get_account_info для получения оперативной статистики по конкретному аккаунту. Не требует сетевого вызова. Никогда не возвращает ключи API и никакие секретные данные. Возвращает: JSON c `accounts`: массив из {name, read_only, dry_run, is_default}. Запись 'default' появляется только когда задана MAILCHIMP_API_KEY.

Параметры

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

list_audience_abuse_reportsтолько чтение

Выводит жалобы на спам, поданные на аудиторию. Используйте, чтобы отслеживать состояние доставляемости и находить кампании, которые вызывают жалобы на спам. Для детального просмотра одной жалобы вызывайте get_audience_abuse_report. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. count: Сколько жалоб вернуть (1-1000, по умолчанию 10). offset: Смещение для пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом abuse_reports. Каждый элемент: id (report_id), campaign_id, list_id, email_id, email_address, date (ISO 8601 — дата подачи жалобы).

Выводит жалобы на спам, поданные на аудиторию. Используйте, чтобы отслеживать состояние доставляемости и находить кампании, которые вызывают жалобы на спам. Для детального просмотра одной жалобы вызывайте get_audience_abuse_report. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. count: Сколько жалоб вернуть (1-1000, по умолчанию 10). offset: Смещение для пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом abuse_reports. Каждый элемент: id (report_id), campaign_id, list_id, email_id, email_address, date (ISO 8601 — дата подачи жалобы).

Параметры

  • list_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
list_audience_membersтолько чтение

Выводит список участников конкретной аудитории со статусом подписки, полями слияния и статистикой вовлечённости. Используйте, чтобы просмотреть участников известной аудитории. Для поиска конкретного человека по email или имени по всем аудиториям используйте search_members. Чтобы вывести участников конкретного сегмента или тега, используйте list_segment_members. Аргументы: list_id: ID аудитории/списка Mailchimp (например, 'abc123def4'). Получите из list_audiences. count: Количество возвращаемых участников (1-1000, по умолчанию 20). offset: Смещение для пагинации. Используйте, когда total_items превышает count. status: Фильтр по статусу подписки. Допустимые значения: 'subscribed', 'unsubscribed', 'cleaned', 'pending', 'transactional'. Если опустить, вернутся все статусы. Возвращает: JSON с total_items и массивом members. Каждый участник: id (MD5-хэш email), email_address, status, full_name, merge_fields (объект с FNAME, LNAME и т.д.), open_rate (десятичное число от 0 до 1), click_rate (десятичное число от 0 до 1), timestamp_opt (время подписки в формате ISO 8601). Пример: list_audience_members(list_id="abc123", count=50, status="subscribed") -> {"total_items": 5000, "members": [{"email_address": "jane@co.com", "status": "subscribed", ...}]}

Выводит список участников конкретной аудитории со статусом подписки, полями слияния и статистикой вовлечённости. Используйте, чтобы просмотреть участников известной аудитории. Для поиска конкретного человека по email или имени по всем аудиториям используйте search_members. Чтобы вывести участников конкретного сегмента или тега, используйте list_segment_members. Аргументы: list_id: ID аудитории/списка Mailchimp (например, 'abc123def4'). Получите из list_audiences. count: Количество возвращаемых участников (1-1000, по умолчанию 20). offset: Смещение для пагинации. Используйте, когда total_items превышает count. status: Фильтр по статусу подписки. Допустимые значения: 'subscribed', 'unsubscribed', 'cleaned', 'pending', 'transactional'. Если опустить, вернутся все статусы. Возвращает: JSON с total_items и массивом members. Каждый участник: id (MD5-хэш email), email_address, status, full_name, merge_fields (объект с FNAME, LNAME и т.д.), open_rate (десятичное число от 0 до 1), click_rate (десятичное число от 0 до 1), timestamp_opt (время подписки в формате ISO 8601). Пример: list_audience_members(list_id="abc123", count=50, status="subscribed") -> {"total_items": 5000, "members": [{"email_address": "jane@co.com", "status": "subscribed", ...}]}

Параметры

  • list_idstringобязательный
  • countinteger
  • offsetinteger
  • statusany
  • accountany
list_audiencesтолько чтение

Возвращает список аудиторий (списков) с количеством подписчиков и уровнем вовлечённости. Первый шаг в большинстве рабочих процессов — получить значения list_id. Используйте get_audience_details для полной статистики по известной аудитории. Используйте search_members для поиска конкретного подписчика. Аргументы: count: Количество возвращаемых аудиторий (1–1000, по умолчанию 10). У большинства аккаунтов меньше 10. offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом audiences. Каждый элемент: id (используйте как list_id), name, member_count, unsubscribe_count, open_rate (0–1), click_rate (0–1), date_created, а также настройки аудитории, которые приходят в том же payload списка: campaign_defaults (default from_name, from_email, subject, language), double_optin (bool: true = подтверждённый/двойной opt-in), marketing_permissions (bool: включены ли поля разрешений GDPR). Эти настройки достаются бесплатно из этого вызова — endpoint /lists возвращает полный объект каждого списка, так что все аудитории и их конфигурация opt-in/отправитель/комплаенс доступны в одном запросе, без вызова get_audience_details для каждой аудитории.

Возвращает список аудиторий (списков) с количеством подписчиков и уровнем вовлечённости. Первый шаг в большинстве рабочих процессов — получить значения list_id. Используйте get_audience_details для полной статистики по известной аудитории. Используйте search_members для поиска конкретного подписчика. Аргументы: count: Количество возвращаемых аудиторий (1–1000, по умолчанию 10). У большинства аккаунтов меньше 10. offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом audiences. Каждый элемент: id (используйте как list_id), name, member_count, unsubscribe_count, open_rate (0–1), click_rate (0–1), date_created, а также настройки аудитории, которые приходят в том же payload списка: campaign_defaults (default from_name, from_email, subject, language), double_optin (bool: true = подтверждённый/двойной opt-in), marketing_permissions (bool: включены ли поля разрешений GDPR). Эти настройки достаются бесплатно из этого вызова — endpoint /lists возвращает полный объект каждого списка, так что все аудитории и их конфигурация opt-in/отправитель/комплаенс доступны в одном запросе, без вызова get_audience_details для каждой аудитории.

Параметры

  • countinteger
  • offsetinteger
  • accountany
list_authorized_appsтолько чтение

Получает список приложений, которым предоставлен OAuth-доступ к этой учетной записи Mailchimp. Используйте это, чтобы проверить, какие сторонние приложения подключены, и узнать их ID. Для полной информации об одном приложении используйте get_authorized_app. Возвращает: JSON с полями total_items и apps (массив). Каждое приложение: id, name, description, users (массив — имена пользователей учетной записи, которые дали доступ).

Получает список приложений, которым предоставлен OAuth-доступ к этой учетной записи Mailchimp. Используйте это, чтобы проверить, какие сторонние приложения подключены, и узнать их ID. Для полной информации об одном приложении используйте get_authorized_app. Возвращает: JSON с полями total_items и apps (массив). Каждое приложение: id, name, description, users (массив — имена пользователей учетной записи, которые дали доступ).

Параметры

  • accountany
list_automation_removed_subscribersтолько чтение

Перечисляет подписчиков, удалённых из классического рабочего процесса автоматизации. Получает всех подписчиков, которые были удалены из указанного рабочего процесса автоматизации. Удалённые подписчики больше не получают никаких писем в рамках рабочего процесса. Аргументы: workflow_id: Уникальный идентификатор классического рабочего процесса автоматизации. Возвращает: JSON со списком удалённых подписчиков.

Перечисляет подписчиков, удалённых из классического рабочего процесса автоматизации. Получает всех подписчиков, которые были удалены из указанного рабочего процесса автоматизации. Удалённые подписчики больше не получают никаких писем в рамках рабочего процесса. Аргументы: workflow_id: Уникальный идентификатор классического рабочего процесса автоматизации. Возвращает: JSON со списком удалённых подписчиков.

Параметры

  • workflow_idstringобязательный
  • accountany
list_automationsтолько чтение

Выводит список классических автоматизаций (Classic Automations) в аккаунте с указанием статуса и количества отправленных писем. Возвращает только классические автоматизации — отсортированы по дате создания по убыванию. Customer Journeys НЕ возвращаются (Mailchimp не предоставляет публичную read-точку для journeys; публична только journey-step trigger endpoint). Чтобы узнать, что отправляют ваши Customer Journeys, используйте search_automation_campaigns (он перечисляет все кампании, созданные любой из двух систем). Для отдельных писем внутри классического workflow используйте get_automation_emails. Для сводки с подсчётом по обеим системам используйте get_automation_summary. Аргументы: count: Количество возвращаемых автоматизаций (1–1000, по умолчанию 20). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом automations. Каждый элемент: id, status ('sending'/'paused'/'draft'), title, emails_sent, start_time, create_time, list_id.

Выводит список классических автоматизаций (Classic Automations) в аккаунте с указанием статуса и количества отправленных писем. Возвращает только классические автоматизации — отсортированы по дате создания по убыванию. Customer Journeys НЕ возвращаются (Mailchimp не предоставляет публичную read-точку для journeys; публична только journey-step trigger endpoint). Чтобы узнать, что отправляют ваши Customer Journeys, используйте search_automation_campaigns (он перечисляет все кампании, созданные любой из двух систем). Для отдельных писем внутри классического workflow используйте get_automation_emails. Для сводки с подсчётом по обеим системам используйте get_automation_summary. Аргументы: count: Количество возвращаемых автоматизаций (1–1000, по умолчанию 20). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом automations. Каждый элемент: id, status ('sending'/'paused'/'draft'), title, emails_sent, start_time, create_time, list_id.

Параметры

  • countinteger
  • offsetinteger
  • accountany
list_batchesтолько чтение

Выводит список недавних пакетных операций со статусом и прогрессом. Используйте get_batch_status для подробного прогресса по конкретному пакету. Args: count: Количество возвращаемых пакетных операций (1-1000, по умолчанию 20). offset: Смещение для пагинации. Используйте, когда total_items превышает count. Returns: JSON с полями total_items и массивом batches. Каждый элемент: id, status ('pending'/'started'/'finished'), total_operations, finished_operations, errored_operations, submitted_at, completed_at.

Выводит список недавних пакетных операций со статусом и прогрессом. Используйте get_batch_status для подробного прогресса по конкретному пакету. Args: count: Количество возвращаемых пакетных операций (1-1000, по умолчанию 20). offset: Смещение для пагинации. Используйте, когда total_items превышает count. Returns: JSON с полями total_items и массивом batches. Каждый элемент: id, status ('pending'/'started'/'finished'), total_operations, finished_operations, errored_operations, submitted_at, completed_at.

Параметры

  • countinteger
  • offsetinteger
  • accountany
list_batch_webhooksтолько чтение

Выводит список всех настроенных batch webhooks для аккаунта. Batch webhooks уведомляют URL по завершении пакетной операции (batch operation). Используйте для получения значений batch_webhook_id, а get_batch_webhook для детального просмотра. Возвращает: JSON с total_items и массивом webhooks. Каждый элемент: id (batch_webhook_id), url, enabled (boolean).

Выводит список всех настроенных batch webhooks для аккаунта. Batch webhooks уведомляют URL по завершении пакетной операции (batch operation). Используйте для получения значений batch_webhook_id, а get_batch_webhook для детального просмотра. Возвращает: JSON с total_items и массивом webhooks. Каждый элемент: id (batch_webhook_id), url, enabled (boolean).

Параметры

  • accountany
list_campaign_feedbackтолько чтение

Выводит комментарии обратной связи по совместной работе команды над кампанией. Используйте для просмотра внутренних заметок и комментариев, оставленных участниками команды во время подготовки кампании. Для получения подробной информации об отдельном комментарии используйте get_campaign_feedback. Чтобы найти ID кампаний, используйте get_campaign_details. Args: campaign_id: ID кампании, для которой нужно вывести обратную связь. Получить из list_campaigns или search_campaigns. Returns: JSON с полем total_items и массивом feedback. Каждый элемент: feedback_id, message, is_complete, block_id, created_by, created_at, updated_at.

Выводит комментарии обратной связи по совместной работе команды над кампанией. Используйте для просмотра внутренних заметок и комментариев, оставленных участниками команды во время подготовки кампании. Для получения подробной информации об отдельном комментарии используйте get_campaign_feedback. Чтобы найти ID кампаний, используйте get_campaign_details. Args: campaign_id: ID кампании, для которой нужно вывести обратную связь. Получить из list_campaigns или search_campaigns. Returns: JSON с полем total_items и массивом feedback. Каждый элемент: feedback_id, message, is_complete, block_id, created_by, created_at, updated_at.

Параметры

  • campaign_idstringобязательный
  • accountany
list_campaign_foldersтолько чтение

Выводит список папок кампаний, используемых для организации кампаний в панели управления Mailchimp. Папки — это только организационные контейнеры; они не влияют на отправку или поведение кампаний. Возвращает пустой массив, если папок нет. Не используйте для поиска кампаний; вместо этого используйте list_campaigns или search_campaigns. Аргументы: count: Количество папок для возврата (1-1000, по умолчанию 50). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом folders. Каждая папка: id, name, count (количество кампаний в папке).

Выводит список папок кампаний, используемых для организации кампаний в панели управления Mailchimp. Папки — это только организационные контейнеры; они не влияют на отправку или поведение кампаний. Возвращает пустой массив, если папок нет. Не используйте для поиска кампаний; вместо этого используйте list_campaigns или search_campaigns. Аргументы: count: Количество папок для возврата (1-1000, по умолчанию 50). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом folders. Каждая папка: id, name, count (количество кампаний в папке).

Параметры

  • countinteger
  • offsetinteger
  • accountany
list_campaignsтолько чтение

Выводит список кампаний с метаданными, статистикой отправки и фильтрацией по статусу или дате. Используйте для просмотра кампаний и поиска их ID. Для полных настроек одной кампании используйте get_campaign_details. Для метрик эффективности после отправки — get_campaign_report. Для поиска кампаний по ключевому слову вместо просмотра используйте search_campaigns. Аргументы: count: количество возвращаемых кампаний (1-1000, по умолчанию 20). offset: смещение пагинации. Используйте, когда total_items превышает count. status: фильтр по статусу. Допустимые значения: 'save' (черновик), 'paused', 'schedule', 'sending', 'sent'. Не указывайте, чтобы вернуть все статусы. since_send_time: возвращать только кампании, отправленные после этого времени. Формат ISO 8601 (например, '2025-01-01T00:00:00Z'). Применяется только к отправленным кампаниям. Возвращает: JSON с полем total_items и массивом campaigns. Каждая кампания содержит: id, type ('regular', 'plaintext', 'absplit', 'rss', 'variate'), status, title, subject_line, preview_text, send_time (ISO 8601 или null), emails_sent, list_id, list_name. Пример: list_campaigns(count=10, status="sent") -> {"total_items": 42, "campaigns": [{"id": "abc123", "status": "sent", ...}]}

Выводит список кампаний с метаданными, статистикой отправки и фильтрацией по статусу или дате. Используйте для просмотра кампаний и поиска их ID. Для полных настроек одной кампании используйте get_campaign_details. Для метрик эффективности после отправки — get_campaign_report. Для поиска кампаний по ключевому слову вместо просмотра используйте search_campaigns. Аргументы: count: количество возвращаемых кампаний (1-1000, по умолчанию 20). offset: смещение пагинации. Используйте, когда total_items превышает count. status: фильтр по статусу. Допустимые значения: 'save' (черновик), 'paused', 'schedule', 'sending', 'sent'. Не указывайте, чтобы вернуть все статусы. since_send_time: возвращать только кампании, отправленные после этого времени. Формат ISO 8601 (например, '2025-01-01T00:00:00Z'). Применяется только к отправленным кампаниям. Возвращает: JSON с полем total_items и массивом campaigns. Каждая кампания содержит: id, type ('regular', 'plaintext', 'absplit', 'rss', 'variate'), status, title, subject_line, preview_text, send_time (ISO 8601 или null), emails_sent, list_id, list_name. Пример: list_campaigns(count=10, status="sent") -> {"total_items": 42, "campaigns": [{"id": "abc123", "status": "sent", ...}]}

Параметры

  • countinteger
  • offsetinteger
  • statusany
  • since_send_timeany
  • accountany
list_connected_sitesтолько чтение

Выводит список всех сайтов, подключенных к этой учетной записи Mailchimp для отслеживания и всплывающих форм. Используйте эту команду, чтобы найти идентификаторы подключенных сайтов и проверить статус установки скрипта на каждом сайте. Чтобы получить полную запись об одном сайте, используйте get_connected_site. Возвращает: JSON с полями total_items и массивом sites. Каждый сайт содержит: id, foreign_id, domain, site_script (объект с полями url и fragment), status, created_at, updated_at.

Выводит список всех сайтов, подключенных к этой учетной записи Mailchimp для отслеживания и всплывающих форм. Используйте эту команду, чтобы найти идентификаторы подключенных сайтов и проверить статус установки скрипта на каждом сайте. Чтобы получить полную запись об одном сайте, используйте get_connected_site. Возвращает: JSON с полями total_items и массивом sites. Каждый сайт содержит: id, foreign_id, domain, site_script (объект с полями url и fragment), status, created_at, updated_at.

Параметры

  • accountany
list_ecommerce_storesтолько чтение

Выводит список подключенных магазинов электронной коммерции (Shopify, WooCommerce и т.д.) с информацией о платформе и валюте. Используйте, чтобы узнать ID магазинов для list_store_orders, list_store_products, list_store_customers. Также проверяет статус интеграции перед get_ecommerce_product_activity. Возвращает total_items: 0, если интеграция не настроена. Возвращает: JSON с total_items и массивом stores. Каждый элемент: id (используйте как store_id), list_id, name, platform, domain, currency_code (ISO 4217), money_format, created_at.

Выводит список подключенных магазинов электронной коммерции (Shopify, WooCommerce и т.д.) с информацией о платформе и валюте. Используйте, чтобы узнать ID магазинов для list_store_orders, list_store_products, list_store_customers. Также проверяет статус интеграции перед get_ecommerce_product_activity. Возвращает total_items: 0, если интеграция не настроена. Возвращает: JSON с total_items и массивом stores. Каждый элемент: id (используйте как store_id), list_id, name, platform, domain, currency_code (ISO 4217), money_format, created_at.

Параметры

  • accountany
list_file_foldersтолько чтение

Выводит список папок в Файловом менеджере аккаунта. Используйте, чтобы узнать значения folder_id для организации или адресации загрузок через upload_file. Чтобы увидеть сами файлы, вызывайте list_files. Аргументы: count: Количество папок для вывода (1-1000, по умолчанию 10). offset: Смещение для пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом folders. Каждая папка: id (используйте как folder_id), name, file_count, created_at, created_by.

Выводит список папок в Файловом менеджере аккаунта. Используйте, чтобы узнать значения folder_id для организации или адресации загрузок через upload_file. Чтобы увидеть сами файлы, вызывайте list_files. Аргументы: count: Количество папок для вывода (1-1000, по умолчанию 10). offset: Смещение для пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом folders. Каждая папка: id (используйте как folder_id), name, file_count, created_at, created_by.

Параметры

  • countinteger
  • offsetinteger
  • accountany
list_filesтолько чтение

Вывести список изображений и файлов, хранящихся в File Manager аккаунта. Используйте, чтобы узнать file_id и хостированные URL для встраивания изображений в контент кампании или шаблона. Используйте get_file для полных метаданных одного файла, upload_file для добавления нового файла и list_file_folders для просмотра структуры папок. Аргументы: count: количество файлов для возврата (1-1000, по умолчанию 10). offset: смещение пагинации. Используйте, когда total_items превышает count. type: необязательный фильтр типа медиа. Либо 'image', либо 'file' (не изображение). Опустите для всех. Возвращает: JSON с total_items и массивом files. Каждый файл: id (используйте как file_id), name, type ('image' или 'file'), full_size_url (хостированный URL для встраивания), thumbnail_url, size (байты), width, height, folder_id, created_at, created_by.

Вывести список изображений и файлов, хранящихся в File Manager аккаунта. Используйте, чтобы узнать file_id и хостированные URL для встраивания изображений в контент кампании или шаблона. Используйте get_file для полных метаданных одного файла, upload_file для добавления нового файла и list_file_folders для просмотра структуры папок. Аргументы: count: количество файлов для возврата (1-1000, по умолчанию 10). offset: смещение пагинации. Используйте, когда total_items превышает count. type: необязательный фильтр типа медиа. Либо 'image', либо 'file' (не изображение). Опустите для всех. Возвращает: JSON с total_items и массивом files. Каждый файл: id (используйте как file_id), name, type ('image' или 'file'), full_size_url (хостированный URL для встраивания), thumbnail_url, size (байты), width, height, folder_id, created_at, created_by.

Параметры

  • countinteger
  • offsetinteger
  • typeany
  • accountany
list_interest_categoriesтолько чтение

Выводит категории интересов (групповые контейнеры) для аудитории: заголовки и типы форм. Используйте, чтобы узнать ID категорий, затем вызывайте list_interests для вариантов внутри каждой. Чтобы добавить новые категории, вызывайте create_interest_category. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. count: Сколько категорий вернуть (1-1000, по умолчанию 50). offset: Смещение для пагинации. Используйте, если total_items превышает count. Возвращает: JSON с total_items и массивом categories. Каждая категория: id, title, type ('checkboxes'/'dropdown'/'radio'/'hidden'), list_id.

Выводит категории интересов (групповые контейнеры) для аудитории: заголовки и типы форм. Используйте, чтобы узнать ID категорий, затем вызывайте list_interests для вариантов внутри каждой. Чтобы добавить новые категории, вызывайте create_interest_category. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. count: Сколько категорий вернуть (1-1000, по умолчанию 50). offset: Смещение для пагинации. Используйте, если total_items превышает count. Возвращает: JSON с total_items и массивом categories. Каждая категория: id, title, type ('checkboxes'/'dropdown'/'radio'/'hidden'), list_id.

Параметры

  • list_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
list_interestsтолько чтение

Выводит варианты интересов внутри категории с количеством подписчиков для каждого варианта. Используйте после list_interest_categories, чтобы увидеть отдельные варианты (например "Tech", "Sports"). Идентификаторы интересов нужны при настройке предпочтений участников через add_member/update_member. НЕ используйте для управления предпочтениями участников напрямую; устанавливайте интересы для каждого участника через API. Возвращает ошибку 404, если category_id недействителен. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. category_id: ID категории интересов. Получить из list_interest_categories. count: Количество возвращаемых интересов (1-1000, по умолчанию 50). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом interests. Каждый интерес: id, name, subscriber_count, display_order.

Выводит варианты интересов внутри категории с количеством подписчиков для каждого варианта. Используйте после list_interest_categories, чтобы увидеть отдельные варианты (например "Tech", "Sports"). Идентификаторы интересов нужны при настройке предпочтений участников через add_member/update_member. НЕ используйте для управления предпочтениями участников напрямую; устанавливайте интересы для каждого участника через API. Возвращает ошибку 404, если category_id недействителен. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. category_id: ID категории интересов. Получить из list_interest_categories. count: Количество возвращаемых интересов (1-1000, по умолчанию 50). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом interests. Каждый интерес: id, name, subscriber_count, display_order.

Параметры

  • list_idstringобязательный
  • category_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
list_landing_page_reportsтолько чтение

Список отчетов по всем целевым страницам. Получает сводные отчеты по эффективности для каждой целевой страницы в аккаунте. Используйте count и offset для пролистывания больших наборов результатов. Аргументы: count: Количество записей на страницу (по умолчанию 10). offset: Количество записей для пропуска при пагинации (по умолчанию 0). Возвращает: JSON со списком отчетов по целевым страницам.

Список отчетов по всем целевым страницам. Получает сводные отчеты по эффективности для каждой целевой страницы в аккаунте. Используйте count и offset для пролистывания больших наборов результатов. Аргументы: count: Количество записей на страницу (по умолчанию 10). offset: Количество записей для пропуска при пагинации (по умолчанию 0). Возвращает: JSON со списком отчетов по целевым страницам.

Параметры

  • countinteger
  • offsetinteger
  • accountany
list_landing_pagesтолько чтение

Выводит список лендингов со статусом публикации, URL и привязанными аудиториями. Лендинги — это отдельные веб-страницы, а не письма. Для полной информации используй get_landing_page. Не используй для поиска email-кампаний — для этого есть list_campaigns. Аргументы: count: сколько лендингов вернуть (1-1000, по умолчанию 20). offset: смещение для постраничного вывода. Используй, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом landing_pages. Каждый элемент: id, name, title, status ('published'/'unpublished'/'draft'), url (null, если не опубликован), published_at, created_at, list_id.

Выводит список лендингов со статусом публикации, URL и привязанными аудиториями. Лендинги — это отдельные веб-страницы, а не письма. Для полной информации используй get_landing_page. Не используй для поиска email-кампаний — для этого есть list_campaigns. Аргументы: count: сколько лендингов вернуть (1-1000, по умолчанию 20). offset: смещение для постраничного вывода. Используй, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом landing_pages. Каждый элемент: id, name, title, status ('published'/'unpublished'/'draft'), url (null, если не опубликован), published_at, created_at, list_id.

Параметры

  • countinteger
  • offsetinteger
  • accountany
list_member_notesтолько чтение

Перечисляет заметки в стиле CRM, прикреплённые к подписчику участниками команды (не видны контакту). Заметки — внутренние пометки вроде «Звонили по поводу цен» или «VIP-клиент». Они не отправляются контакту и не влияют на доставляемость. Используйте add_member_note, чтобы создать, update_member_note — чтобы отредактировать, delete_member_note — чтобы удалить. Возвращает ошибку 404, если подписчик не существует. Параметры: list_id: ID списка/аудитории (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. email_address: Email подписчика, чьи заметки нужно перечислить. Должен существовать в аудитории. count: Количество возвращаемых заметок (1-1000, по умолчанию 20). offset: Смещение для постраничного вывода. Используйте, когда total_items превышает count. Возвращает: JSON с email_address, total_items и массивом notes. Каждая заметка: id (используется как note_id), note (строка, текст), created_at, created_by, updated_at.

Перечисляет заметки в стиле CRM, прикреплённые к подписчику участниками команды (не видны контакту). Заметки — внутренние пометки вроде «Звонили по поводу цен» или «VIP-клиент». Они не отправляются контакту и не влияют на доставляемость. Используйте add_member_note, чтобы создать, update_member_note — чтобы отредактировать, delete_member_note — чтобы удалить. Возвращает ошибку 404, если подписчик не существует. Параметры: list_id: ID списка/аудитории (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. email_address: Email подписчика, чьи заметки нужно перечислить. Должен существовать в аудитории. count: Количество возвращаемых заметок (1-1000, по умолчанию 20). offset: Смещение для постраничного вывода. Используйте, когда total_items превышает count. Возвращает: JSON с email_address, total_items и массивом notes. Каждая заметка: id (используется как note_id), note (строка, текст), created_at, created_by, updated_at.

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • countinteger
  • offsetinteger
  • accountany
list_merge_fieldsтолько чтение

Выводит поля слияния (пользовательские поля данных), заданные для аудитории: теги, типы и значения по умолчанию. Используется, чтобы узнать доступные поля слияния и их теги перед добавлением или обновлением участников. Стандартные поля (FNAME, LNAME, ADDRESS, PHONE) присутствуют всегда. Для добавления пользовательских полей используйте create_merge_field. Теги полей слияния применяются в объектах merge_fields у add_member/update_member, а также в содержимом писем как теги слияния *|TAG|*. Аргументы: list_id: ID аудитории/списка Mailchimp (например 'abc123def4'). Получить из list_audiences. count: Количество полей слияния для возврата (1-1000, по умолчанию 50). offset: Смещение пагинации. Используйте, если total_items превышает count. Возвращает: JSON с полями total_items и массивом merge_fields. Каждое поле: merge_id (int, используется с update_merge_field/delete_merge_field), tag (строка, например 'FNAME'), name (отображаемое имя), type ('text', 'number', 'date' и т. д.), required (булево), default_value, options (выбор для типов dropdown/radio). Пример: list_merge_fields(list_id="abc123") -> {"total_items": 6, "merge_fields": [{"merge_id": 1, "tag": "FNAME", "name": "First Name", "type": "text", ...}]}

Выводит поля слияния (пользовательские поля данных), заданные для аудитории: теги, типы и значения по умолчанию. Используется, чтобы узнать доступные поля слияния и их теги перед добавлением или обновлением участников. Стандартные поля (FNAME, LNAME, ADDRESS, PHONE) присутствуют всегда. Для добавления пользовательских полей используйте create_merge_field. Теги полей слияния применяются в объектах merge_fields у add_member/update_member, а также в содержимом писем как теги слияния *|TAG|*. Аргументы: list_id: ID аудитории/списка Mailchimp (например 'abc123def4'). Получить из list_audiences. count: Количество полей слияния для возврата (1-1000, по умолчанию 50). offset: Смещение пагинации. Используйте, если total_items превышает count. Возвращает: JSON с полями total_items и массивом merge_fields. Каждое поле: merge_id (int, используется с update_merge_field/delete_merge_field), tag (строка, например 'FNAME'), name (отображаемое имя), type ('text', 'number', 'date' и т. д.), required (булево), default_value, options (выбор для типов dropdown/radio). Пример: list_merge_fields(list_id="abc123") -> {"total_items": 6, "merge_fields": [{"merge_id": 1, "tag": "FNAME", "name": "First Name", "type": "text", ...}]}

Параметры

  • list_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
list_promo_codesтолько чтение

Список кодов, привязанных к правилу промоакции (например, 'SUMMER20', 'VIPONLY'). Коды — это то, что покупатели вводят при оформлении заказа. Они активируют скидку, заданную правилом. Одно правило может содержать много кодов (например, по одному на каждый сегмент покупателей). Аргументы: store_id: ID интернет-магазина. promo_rule_id: ID правила. Получить из list_promo_rules. count: Количество кодов для возврата (1-1000, по умолчанию 20). offset: Смещение для постраничного вывода. Возвращает: JSON с store_id, promo_rule_id, total_items и массивом promo_codes. Каждый код: id, code (строка, которую вводят покупатели), redemption_url, usage_count, enabled, created_at, updated_at.

Список кодов, привязанных к правилу промоакции (например, 'SUMMER20', 'VIPONLY'). Коды — это то, что покупатели вводят при оформлении заказа. Они активируют скидку, заданную правилом. Одно правило может содержать много кодов (например, по одному на каждый сегмент покупателей). Аргументы: store_id: ID интернет-магазина. promo_rule_id: ID правила. Получить из list_promo_rules. count: Количество кодов для возврата (1-1000, по умолчанию 20). offset: Смещение для постраничного вывода. Возвращает: JSON с store_id, promo_rule_id, total_items и массивом promo_codes. Каждый код: id, code (строка, которую вводят покупатели), redemption_url, usage_count, enabled, created_at, updated_at.

Параметры

  • store_idstringобязательный
  • promo_rule_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
list_promo_rulesтолько чтение

Выводит список правил скидок/акций, настроенных для магазина (фиксированная сумма, процент, бесплатная доставка). Правило акции определяет механику скидки (например, «скидка 20% на весь заказ»). Коды, которые вводят покупатели, привязываются к правилам через list_promo_codes / create_promo_code. Аргументы: store_id: ID магазина электронной коммерции. Получить из list_ecommerce_stores. count: Количество правил для возврата (1-1000, по умолчанию 20). offset: Смещение пагинации. Возвращает: JSON с store_id, total_items и массивом promo_rules. Каждое правило: id, title, description, amount, type ('fixed' | 'percentage'), target ('per_item' | 'total' | 'shipping'), enabled (bool), starts_at, ends_at, created_at, updated_at.

Выводит список правил скидок/акций, настроенных для магазина (фиксированная сумма, процент, бесплатная доставка). Правило акции определяет механику скидки (например, «скидка 20% на весь заказ»). Коды, которые вводят покупатели, привязываются к правилам через list_promo_codes / create_promo_code. Аргументы: store_id: ID магазина электронной коммерции. Получить из list_ecommerce_stores. count: Количество правил для возврата (1-1000, по умолчанию 20). offset: Смещение пагинации. Возвращает: JSON с store_id, total_items и массивом promo_rules. Каждое правило: id, title, description, amount, type ('fixed' | 'percentage'), target ('per_item' | 'total' | 'shipping'), enabled (bool), starts_at, ends_at, created_at, updated_at.

Параметры

  • store_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
list_segment_membersтолько чтение

Выводит список участников из определённого сегмента или тега. Используйте, чтобы посмотреть, кто входит в сегмент. Используйте list_audience_members, чтобы просмотреть всех участников всей аудитории. Сначала используйте get_segment, чтобы проверить метаданные сегмента и количество участников. Аргументы: list_id: Идентификатор аудитории/списка Mailchimp (например, 'abc123def4'). Получите из list_audiences. segment_id: Идентификатор сегмента (числовая строка, например, '12345'). Получите из list_segments. count: Сколько участников вернуть (1-1000, по умолчанию 20). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом members. Каждый участник: id, email_address, status, full_name, merge_fields (объект с FNAME, LNAME и т.д.). Пример: list_segment_members(list_id="abc123", segment_id="12345", count=50) -> {"total_items": 150, "members": [{"email_address": "jane@co.com", ...}]}

Выводит список участников из определённого сегмента или тега. Используйте, чтобы посмотреть, кто входит в сегмент. Используйте list_audience_members, чтобы просмотреть всех участников всей аудитории. Сначала используйте get_segment, чтобы проверить метаданные сегмента и количество участников. Аргументы: list_id: Идентификатор аудитории/списка Mailchimp (например, 'abc123def4'). Получите из list_audiences. segment_id: Идентификатор сегмента (числовая строка, например, '12345'). Получите из list_segments. count: Сколько участников вернуть (1-1000, по умолчанию 20). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом members. Каждый участник: id, email_address, status, full_name, merge_fields (объект с FNAME, LNAME и т.д.). Пример: list_segment_members(list_id="abc123", segment_id="12345", count=50) -> {"total_items": 150, "members": [{"email_address": "jane@co.com", ...}]}

Параметры

  • list_idstringобязательный
  • segment_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
list_segmentsтолько чтение

Перечисляет сегменты и теги для аудитории с количеством участников и типами. Используйте, чтобы найти идентификаторы сегментов для таргетинга кампаний или управления участниками. Возвращает как статические (теги, ручные), так и динамические (сохраненные, автообновляемые) сегменты. Используйте get_segment для полной информации, включая условия фильтрации. Аргументы: list_id: ID аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получите из list_audiences. count: Количество возвращаемых сегментов (1-1000, по умолчанию 20). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом segments. Каждый элемент: id (используйте как segment_id), name, member_count, type ('static'/'saved'), created_at, updated_at.

Перечисляет сегменты и теги для аудитории с количеством участников и типами. Используйте, чтобы найти идентификаторы сегментов для таргетинга кампаний или управления участниками. Возвращает как статические (теги, ручные), так и динамические (сохраненные, автообновляемые) сегменты. Используйте get_segment для полной информации, включая условия фильтрации. Аргументы: list_id: ID аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получите из list_audiences. count: Количество возвращаемых сегментов (1-1000, по умолчанию 20). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом segments. Каждый элемент: id (используйте как segment_id), name, member_count, type ('static'/'saved'), created_at, updated_at.

Параметры

  • list_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
list_signup_formsтолько чтение

Получить формы регистрации (заголовок, содержимое тела и стили), настроенные для аудитории. Используйте, чтобы просмотреть текущие встроенные и размещённые формы регистрации перед их изменением с помощью customize_signup_form. Возвращает ошибку 404, если list_id недействителен. Аргументы: list_id — идентификатор аудитории/списка (из list_audiences). Возвращает: JSON с массивом signup_forms. Каждая запись содержит header (объект), contents (массив вида {section, value}), styles (массив вида {section, options}) и signup_form_url.

Получить формы регистрации (заголовок, содержимое тела и стили), настроенные для аудитории. Используйте, чтобы просмотреть текущие встроенные и размещённые формы регистрации перед их изменением с помощью customize_signup_form. Возвращает ошибку 404, если list_id недействителен. Аргументы: list_id — идентификатор аудитории/списка (из list_audiences). Возвращает: JSON с массивом signup_forms. Каждая запись содержит header (объект), contents (массив вида {section, value}), styles (массив вида {section, options}) и signup_form_url.

Параметры

  • list_idstringобязательный
  • accountany
list_store_cartsтолько чтение

Получает список корзин магазина, включая брошенные, с информацией о покупателе и сумме. Корзины в Mailchimp - это незавершённые покупки, синхронизированные с подключённой витриной. Используйте для работы с брошенными корзинами: фильтруйте по недавнему created_at, сегментируйте по сумме корзины, затем запускайте автоматизацию восстановления. Для получения одной корзины с товарными позициями используйте get_store_cart. Для завершённых покупок используйте list_store_orders. Возвращает 404, если store_id недействителен. Args: store_id: ID интернет-магазина. Получите из list_ecommerce_stores. count: Количество корзин для возврата (1-1000, по умолчанию 20). offset: Смещение пагинации. Returns: JSON с store_id, total_items и массивом carts. Каждая корзина: id, customer (объект с id, email_address, opt_in_status), currency_code, order_total, tax_total, checkout_url, created_at, updated_at.

Получает список корзин магазина, включая брошенные, с информацией о покупателе и сумме. Корзины в Mailchimp - это незавершённые покупки, синхронизированные с подключённой витриной. Используйте для работы с брошенными корзинами: фильтруйте по недавнему created_at, сегментируйте по сумме корзины, затем запускайте автоматизацию восстановления. Для получения одной корзины с товарными позициями используйте get_store_cart. Для завершённых покупок используйте list_store_orders. Возвращает 404, если store_id недействителен. Args: store_id: ID интернет-магазина. Получите из list_ecommerce_stores. count: Количество корзин для возврата (1-1000, по умолчанию 20). offset: Смещение пагинации. Returns: JSON с store_id, total_items и массивом carts. Каждая корзина: id, customer (объект с id, email_address, opt_in_status), currency_code, order_total, tax_total, checkout_url, created_at, updated_at.

Параметры

  • store_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
list_store_customersтолько чтение

Выводит список покупателей из подключённого интернет-магазина с количеством заказов, общей суммой трат и статусом согласия. Используйте для анализа покупательского поведения или выявления ценных клиентов. Требуется активная интеграция с интернет-магазином. Используйте list_ecommerce_stores, чтобы найти ID магазина. Для деталей по каждому заказу вместо агрегированных данных по клиентам используйте list_store_orders. Args: store_id: ID интернет-магазина. Получить из list_ecommerce_stores. count: Количество возвращаемых покупателей (1-1000, по умолчанию 20). offset: Смещение для пагинации. Используйте, когда total_items превышает count. Returns: JSON с полями total_items и массивом customers. Каждый покупатель: id (строка), email_address, first_name, last_name, orders_count (целое), total_spent (число с плавающей точкой, в валюте магазина), opt_in_status (boolean), created_at (ISO 8601). Example: list_store_customers(store_id="store123", count=50) -> {"total_items": 500, "customers": [{"email_address": "jane@co.com", "orders_count": 5, "total_spent": 299.95, ...}]}

Выводит список покупателей из подключённого интернет-магазина с количеством заказов, общей суммой трат и статусом согласия. Используйте для анализа покупательского поведения или выявления ценных клиентов. Требуется активная интеграция с интернет-магазином. Используйте list_ecommerce_stores, чтобы найти ID магазина. Для деталей по каждому заказу вместо агрегированных данных по клиентам используйте list_store_orders. Args: store_id: ID интернет-магазина. Получить из list_ecommerce_stores. count: Количество возвращаемых покупателей (1-1000, по умолчанию 20). offset: Смещение для пагинации. Используйте, когда total_items превышает count. Returns: JSON с полями total_items и массивом customers. Каждый покупатель: id (строка), email_address, first_name, last_name, orders_count (целое), total_spent (число с плавающей точкой, в валюте магазина), opt_in_status (boolean), created_at (ISO 8601). Example: list_store_customers(store_id="store123", count=50) -> {"total_items": 500, "customers": [{"email_address": "jane@co.com", "orders_count": 5, "total_spent": 299.95, ...}]}

Параметры

  • store_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
list_store_order_linesтолько чтение

Перечисляет позиции одного заказа в электронной коммерции. Используется для просмотра отдельных товаров, их количества и цен, привязанных к заказу. Manual commerce подходит для кастомных/headless магазинов; интеграции с Shopify и WooCommerce синхронизируют позиции заказов автоматически. Аргументы: store_id: Идентификатор магазина электронной коммерции. Получить из list_ecommerce_stores. order_id: Идентификатор заказа, позиции которого необходимо перечислить. count: Количество возвращаемых позиций (макс. 1000). По умолчанию 10. offset: Количество пропускаемых позиций для пагинации. По умолчанию 0. Возвращает: JSON с полями lines (массив из {id, product_id, product_variant_id, quantity, price, discount}), total_items.

Перечисляет позиции одного заказа в электронной коммерции. Используется для просмотра отдельных товаров, их количества и цен, привязанных к заказу. Manual commerce подходит для кастомных/headless магазинов; интеграции с Shopify и WooCommerce синхронизируют позиции заказов автоматически. Аргументы: store_id: Идентификатор магазина электронной коммерции. Получить из list_ecommerce_stores. order_id: Идентификатор заказа, позиции которого необходимо перечислить. count: Количество возвращаемых позиций (макс. 1000). По умолчанию 10. offset: Количество пропускаемых позиций для пагинации. По умолчанию 0. Возвращает: JSON с полями lines (массив из {id, product_id, product_variant_id, quantity, price, discount}), total_items.

Параметры

  • store_idstringобязательный
  • order_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
list_store_ordersтолько чтение

Выводит заказы из подключенного интернет-магазина с суммами и статусом выполнения. Требуется активная интеграция. Для агрегации на уровне покупателей используйте list_store_customers. Аргументы: store_id: ID интернет-магазина (строка из букв и цифр). Получить из list_ecommerce_stores. count: Количество возвращаемых заказов (1-1000, по умолчанию 20). offset: Смещение для пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом orders. Каждый элемент: id, customer (email), order_total (float), currency_code (ISO 4217), financial_status, fulfillment_status, processed_at_foreign, lines_count.

Выводит заказы из подключенного интернет-магазина с суммами и статусом выполнения. Требуется активная интеграция. Для агрегации на уровне покупателей используйте list_store_customers. Аргументы: store_id: ID интернет-магазина (строка из букв и цифр). Получить из list_ecommerce_stores. count: Количество возвращаемых заказов (1-1000, по умолчанию 20). offset: Смещение для пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с total_items и массивом orders. Каждый элемент: id, customer (email), order_total (float), currency_code (ISO 4217), financial_status, fulfillment_status, processed_at_foreign, lines_count.

Параметры

  • store_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
list_store_product_imagesтолько чтение

Выводит список изображений, прикрепленных к товару в интернет-магазине. Используйте, чтобы просмотреть URL-адреса изображений и связи с вариантами для товара перед их добавлением или обновлением. Ручные записи в коммерции подходят для кастомных/headless магазинов; интеграции Shopify и WooCommerce синхронизируют изображения товаров автоматически. Args: store_id: Идентификатор интернет-магазина. Получите из list_ecommerce_stores. product_id: Идентификатор товара, изображения которого нужно вывести. Получите из list_store_products. count: Количество изображений для возврата (макс. 1000). По умолчанию 10. offset: Количество изображений для пропуска при пагинации. По умолчанию 0. Returns: JSON с изображениями (массив {id, url, variant_ids}) и total_items.

Выводит список изображений, прикрепленных к товару в интернет-магазине. Используйте, чтобы просмотреть URL-адреса изображений и связи с вариантами для товара перед их добавлением или обновлением. Ручные записи в коммерции подходят для кастомных/headless магазинов; интеграции Shopify и WooCommerce синхронизируют изображения товаров автоматически. Args: store_id: Идентификатор интернет-магазина. Получите из list_ecommerce_stores. product_id: Идентификатор товара, изображения которого нужно вывести. Получите из list_store_products. count: Количество изображений для возврата (макс. 1000). По умолчанию 10. offset: Количество изображений для пропуска при пагинации. По умолчанию 0. Returns: JSON с изображениями (массив {id, url, variant_ids}) и total_items.

Параметры

  • store_idstringобязательный
  • product_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
list_store_productsтолько чтение

Выводит список товаров из подключённого интернет-магазина с названиями, URL и количеством вариантов. Используйте, чтобы просматривать каталог товаров, синхронизированный с Mailchimp. Помогает проверить статус синхронизации или найти данные о товарах для контента кампаний. Используйте list_ecommerce_stores, чтобы найти ID магазинов. Используйте get_ecommerce_product_activity для получения данных о доходах от товаров на уровне кампании. Аргументы: store_id: ID интернет-магазина. Получите из list_ecommerce_stores. count: Количество товаров в ответе (1-1000, по умолчанию 20). offset: Смещение для пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом products. Каждый товар содержит: id (строка), title, url (ссылка на страницу товара), vendor (строка), image_url (строка или null), variants_count (целое число). Возвращает total_items: 0, если интеграция не настроена. Пример: list_store_products(store_id="store123", count=50) -> {"total_items": 200, "products": [{"id": "prod_123", "title": "Blue T-Shirt", "variants_count": 3, ...}]}

Выводит список товаров из подключённого интернет-магазина с названиями, URL и количеством вариантов. Используйте, чтобы просматривать каталог товаров, синхронизированный с Mailchimp. Помогает проверить статус синхронизации или найти данные о товарах для контента кампаний. Используйте list_ecommerce_stores, чтобы найти ID магазинов. Используйте get_ecommerce_product_activity для получения данных о доходах от товаров на уровне кампании. Аргументы: store_id: ID интернет-магазина. Получите из list_ecommerce_stores. count: Количество товаров в ответе (1-1000, по умолчанию 20). offset: Смещение для пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом products. Каждый товар содержит: id (строка), title, url (ссылка на страницу товара), vendor (строка), image_url (строка или null), variants_count (целое число). Возвращает total_items: 0, если интеграция не настроена. Пример: list_store_products(store_id="store123", count=50) -> {"total_items": 200, "products": [{"id": "prod_123", "title": "Blue T-Shirt", "variants_count": 3, ...}]}

Параметры

  • store_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
list_store_product_variantsтолько чтение

Перечисляет варианты товара в магазине с постраничной разбивкой. Используется для просмотра вариантов товара и получения variant_ids. Увеличивайте offset для пролистывания больших наборов вариантов. Аргументы: store_id: ID магазина электронной коммерции. product_id: ID товара, варианты которого нужно перечислить. count: Количество возвращаемых вариантов (по умолчанию 10, максимум 1000). offset: Количество пропускаемых вариантов для пагинации (по умолчанию 0). Возвращает: JSON с массивом variants и полем total_items.

Перечисляет варианты товара в магазине с постраничной разбивкой. Используется для просмотра вариантов товара и получения variant_ids. Увеличивайте offset для пролистывания больших наборов вариантов. Аргументы: store_id: ID магазина электронной коммерции. product_id: ID товара, варианты которого нужно перечислить. count: Количество возвращаемых вариантов (по умолчанию 10, максимум 1000). offset: Количество пропускаемых вариантов для пагинации (по умолчанию 0). Возвращает: JSON с массивом variants и полем total_items.

Параметры

  • store_idstringобязательный
  • product_idstringобязательный
  • countinteger
  • offsetinteger
  • accountany
list_survey_reportsтолько чтение

Список отчётов по всем опросам. Получает сводные отчёты о производительности по всем опросам в аккаунте. Для постраничного просмотра больших наборов результатов используются параметры count и offset. Аргументы: count: Количество записей на странице (по умолчанию 10). offset: Количество записей, пропускаемых для пагинации (по умолчанию 0). Возвращает: JSON со списком отчётов по опросам.

Список отчётов по всем опросам. Получает сводные отчёты о производительности по всем опросам в аккаунте. Для постраничного просмотра больших наборов результатов используются параметры count и offset. Аргументы: count: Количество записей на странице (по умолчанию 10). offset: Количество записей, пропускаемых для пагинации (по умолчанию 0). Возвращает: JSON со списком отчётов по опросам.

Параметры

  • countinteger
  • offsetinteger
  • accountany
list_surveysтолько чтение

Список всех опросов для аудитории с их статусом и публичным URL. Используйте, чтобы узнать значения survey_id и посмотреть, какие опросы опубликованы. Используйте get_survey для получения полной информации об одном опросе, а publish_survey / unpublish_survey — чтобы изменить его статус публикации. Возвращает ошибку 404, если list_id неверный. Аргументы: list_id: ID аудитории/списка (из list_audiences). Возвращает: JSON с total_items и массивом surveys. Каждый опрос обычно включает id (используйте как survey_id), title, status ('draft', 'published' или 'unpublished'), url (публичный URL опроса), created_at, updated_at.

Список всех опросов для аудитории с их статусом и публичным URL. Используйте, чтобы узнать значения survey_id и посмотреть, какие опросы опубликованы. Используйте get_survey для получения полной информации об одном опросе, а publish_survey / unpublish_survey — чтобы изменить его статус публикации. Возвращает ошибку 404, если list_id неверный. Аргументы: list_id: ID аудитории/списка (из list_audiences). Возвращает: JSON с total_items и массивом surveys. Каждый опрос обычно включает id (используйте как survey_id), title, status ('draft', 'published' или 'unpublished'), url (публичный URL опроса), created_at, updated_at.

Параметры

  • list_idstringобязательный
  • accountany
list_template_foldersтолько чтение

Выводит список папок для организации шаблонов. Используйте, чтобы узнать ID папок с шаблонами перед созданием или организацией шаблонов. Разбивайте результаты на страницы с помощью параметров count и offset, если total_items превышает count. Аргументы: count: количество возвращаемых папок (1-1000, по умолчанию 10). offset: смещение для постраничного вывода. Используйте, если total_items превышает count. Возвращает: JSON с полем total_items и массивом folders. Каждый элемент: id, name, количество шаблонов.

Выводит список папок для организации шаблонов. Используйте, чтобы узнать ID папок с шаблонами перед созданием или организацией шаблонов. Разбивайте результаты на страницы с помощью параметров count и offset, если total_items превышает count. Аргументы: count: количество возвращаемых папок (1-1000, по умолчанию 10). offset: смещение для постраничного вывода. Используйте, если total_items превышает count. Возвращает: JSON с полем total_items и массивом folders. Каждый элемент: id, name, количество шаблонов.

Параметры

  • countinteger
  • offsetinteger
  • accountany
list_templatesтолько чтение

Выводит список шаблонов писем в аккаунте (созданных пользователем и из галереи Mailchimp). Используйте для просмотра шаблонов и поиска их ID. Вызывайте get_template_default_content, чтобы извлечь HTML из шаблона. Вызывайте create_template, чтобы добавить новые шаблоны. Не используйте для поиска кампаний - для этого есть list_campaigns. Args: count: сколько шаблонов вернуть (1-1000, по умолчанию 20). offset: сдвиг пагинации. Используйте, когда total_items превышает count. Returns: JSON с полями total_items и массивом templates. Каждый шаблон: id (int), name, type ('user'/'gallery'/'base'), date_created, active (boolean).

Выводит список шаблонов писем в аккаунте (созданных пользователем и из галереи Mailchimp). Используйте для просмотра шаблонов и поиска их ID. Вызывайте get_template_default_content, чтобы извлечь HTML из шаблона. Вызывайте create_template, чтобы добавить новые шаблоны. Не используйте для поиска кампаний - для этого есть list_campaigns. Args: count: сколько шаблонов вернуть (1-1000, по умолчанию 20). offset: сдвиг пагинации. Используйте, когда total_items превышает count. Returns: JSON с полями total_items и массивом templates. Каждый шаблон: id (int), name, type ('user'/'gallery'/'base'), date_created, active (boolean).

Параметры

  • countinteger
  • offsetinteger
  • accountany
list_verified_domainsтолько чтение

Выводит список всех доменов отправителя, подтверждённых для использования с этим аккаунтом Mailchimp. Используйте этот инструмент, чтобы узнать, какие домены разрешены в качестве адреса «От кого» в кампаниях, и проверить статус верификации и аутентификации каждого домена. Для получения полной записи по одному домену используйте get_verified_domain. Возвращает: JSON с полями total_items и массивом domains. Каждый элемент: domain, verified (boolean), authenticated (boolean), verification_status, authentication_status.

Выводит список всех доменов отправителя, подтверждённых для использования с этим аккаунтом Mailchimp. Используйте этот инструмент, чтобы узнать, какие домены разрешены в качестве адреса «От кого» в кампаниях, и проверить статус верификации и аутентификации каждого домена. Для получения полной записи по одному домену используйте get_verified_domain. Возвращает: JSON с полями total_items и массивом domains. Каждый элемент: domain, verified (boolean), authenticated (boolean), verification_status, authentication_status.

Параметры

  • accountany
list_webhooksтолько чтение

Выводит список вебхуков, настроенных для аудитории: колбэк-URL, события и фильтры источников. Используйте для аудита интеграций или поиска ID вебхуков перед удалением через delete_webhook. Не используйте для проверки истории доставки вебхуков — Mailchimp не предоставляет логи доставки через API. Аргументы: list_id: ID аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получите из list_audiences. Возвращает: JSON с total_items и массивом webhooks. Каждый вебхук: id, url, events (булевы флаги: subscribe, unsubscribe, profile, cleaned, upemail, campaign), sources (булевы флаги: user, admin, api), list_id.

Выводит список вебхуков, настроенных для аудитории: колбэк-URL, события и фильтры источников. Используйте для аудита интеграций или поиска ID вебхуков перед удалением через delete_webhook. Не используйте для проверки истории доставки вебхуков — Mailchimp не предоставляет логи доставки через API. Аргументы: list_id: ID аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получите из list_audiences. Возвращает: JSON с total_items и массивом webhooks. Каждый вебхук: id, url, events (булевы флаги: subscribe, unsubscribe, profile, cleaned, upemail, campaign), sources (булевы флаги: user, admin, api), list_id.

Параметры

  • list_idstringобязательный
  • accountany
pause_automation

Ставит автоматизацию на паузу: останавливает отправку, но сохраняет очередь. Подписчики в очереди продолжат получать письма, когда автоматизацию перезапустят через start_automation. Новые подписчики по-прежнему попадают в очередь, но пока стоит пауза, письма им не уходят. Операция обратима. Аргументы: automation_id — ID автоматизации (например 'auto123'). Получить можно через list_automations. Возвращает: JSON со статусом ("paused") и automation_id. Ошибка, если автоматизация уже на паузе или в статусе черновика.

Ставит автоматизацию на паузу: останавливает отправку, но сохраняет очередь. Подписчики в очереди продолжат получать письма, когда автоматизацию перезапустят через start_automation. Новые подписчики по-прежнему попадают в очередь, но пока стоит пауза, письма им не уходят. Операция обратима. Аргументы: automation_id — ID автоматизации (например 'auto123'). Получить можно через list_automations. Возвращает: JSON со статусом ("paused") и automation_id. Ошибка, если автоматизация уже на паузе или в статусе черновика.

Параметры

  • automation_idstringобязательный
  • accountany
pause_automation_email

Приостанавливает отправку конкретного письма в классическом автоматическом воркфлоу. Останавливает отправку одного письма автоматизации, не приостанавливая весь воркфлоу. Подписчики, уже поставленные в очередь, остаются в очереди, пока письмо не будет запущено снова. Аргументы: workflow_id: уникальный идентификатор классического автоматического воркфлоу. workflow_email_id: уникальный идентификатор письма автоматизации, которое нужно приостановить. Возвращает: JSON, подтверждающий действие приостановки.

Приостанавливает отправку конкретного письма в классическом автоматическом воркфлоу. Останавливает отправку одного письма автоматизации, не приостанавливая весь воркфлоу. Подписчики, уже поставленные в очередь, остаются в очереди, пока письмо не будет запущено снова. Аргументы: workflow_id: уникальный идентификатор классического автоматического воркфлоу. workflow_email_id: уникальный идентификатор письма автоматизации, которое нужно приостановить. Возвращает: JSON, подтверждающий действие приостановки.

Параметры

  • workflow_idstringобязательный
  • workflow_email_idstringобязательный
  • accountany
pause_rss_campaign

Приостановите активную RSS-кампанию, чтобы она перестала отправлять запланированные выпуски. Используйте, чтобы временно остановить RSS-кампанию; позже возобновите её с помощью resume_rss_campaign. Работает только с кампаниями типа 'rss'. Чтобы убедиться в типе кампании, используйте get_campaign_details. Args: campaign_id: ID RSS-кампании для приостановки. Получите из list_campaigns или search_campaigns. Returns: JSON с ответом API, подтверждающим приостановку, или ошибку, если кампания не RSS.

Приостановите активную RSS-кампанию, чтобы она перестала отправлять запланированные выпуски. Используйте, чтобы временно остановить RSS-кампанию; позже возобновите её с помощью resume_rss_campaign. Работает только с кампаниями типа 'rss'. Чтобы убедиться в типе кампании, используйте get_campaign_details. Args: campaign_id: ID RSS-кампании для приостановки. Получите из list_campaigns или search_campaigns. Returns: JSON с ответом API, подтверждающим приостановку, или ошибку, если кампания не RSS.

Параметры

  • campaign_idstringобязательный
  • accountany
pingтолько чтение

Проверьте подключение к API и убедитесь, что ключ API действителен. Самая быстрая проверка работоспособности. Если нужны сведения об аккаунте, используйте get_account_info. Возвращает объект ошибки, если ключ недействителен или отсутствует. Возвращает: JSON с полем health_check ('ok' если подключено), status_code (200 если в порядке).

Проверьте подключение к API и убедитесь, что ключ API действителен. Самая быстрая проверка работоспособности. Если нужны сведения об аккаунте, используйте get_account_info. Возвращает объект ошибки, если ключ недействителен или отсутствует. Возвращает: JSON с полем health_check ('ok' если подключено), status_code (200 если в порядке).

Параметры

  • accountany
publish_landing_pageидемпотентный

Публикует лендинг, делая его доступным по публичному URL. Идемпотентен для уже опубликованных страниц. Используйте unpublish_landing_page, чтобы снять страницу с публикации. Используйте get_landing_page, чтобы проверить URL после публикации. Возвращает 400, если на странице не хватает обязательного контента; возвращает 404, если page_id недействителен. Аргументы: page_id: ID лендинга для публикации. Получить из list_landing_pages. Возвращает: JSON со статусом ('published') и page_id в случае успеха.

Публикует лендинг, делая его доступным по публичному URL. Идемпотентен для уже опубликованных страниц. Используйте unpublish_landing_page, чтобы снять страницу с публикации. Используйте get_landing_page, чтобы проверить URL после публикации. Возвращает 400, если на странице не хватает обязательного контента; возвращает 404, если page_id недействителен. Аргументы: page_id: ID лендинга для публикации. Получить из list_landing_pages. Возвращает: JSON со статусом ('published') и page_id в случае успеха.

Параметры

  • page_idstringобязательный
  • accountany
publish_survey

Публикует опрос: делает его доступным по публичному URL. Работает для опросов в статусе черновика, неопубликованных или ранее опубликованных, а затем отредактированных. Используйте list_surveys, чтобы найти survey_id и проверить его статус. Используйте unpublish_survey, чтобы отозвать публикацию. Аргументы: list_id: Audience/list ID (из list_audiences). survey_id: Survey ID (из list_surveys). Возвращает: JSON со статусом 'published' и survey_id, или объект ошибки.

Публикует опрос: делает его доступным по публичному URL. Работает для опросов в статусе черновика, неопубликованных или ранее опубликованных, а затем отредактированных. Используйте list_surveys, чтобы найти survey_id и проверить его статус. Используйте unpublish_survey, чтобы отозвать публикацию. Аргументы: list_id: Audience/list ID (из list_audiences). survey_id: Survey ID (из list_surveys). Возвращает: JSON со статусом 'published' и survey_id, или объект ошибки.

Параметры

  • list_idstringобязательный
  • survey_idstringобязательный
  • accountany
remove_automation_subscriber

Удаляет подписчика из классического automation workflow. Навсегда удаляет подписчика из указанного automation workflow, чтобы он не получал дальнейших писем. Это действие нельзя отменить через API. Аргументы: workflow_id: Уникальный идентификатор классического automation workflow. email_address: Адрес электронной почты подписчика, которого нужно удалить. Возвращает: JSON, подтверждающий удаление подписчика.

Удаляет подписчика из классического automation workflow. Навсегда удаляет подписчика из указанного automation workflow, чтобы он не получал дальнейших писем. Это действие нельзя отменить через API. Аргументы: workflow_id: Уникальный идентификатор классического automation workflow. email_address: Адрес электронной почты подписчика, которого нужно удалить. Возвращает: JSON, подтверждающий удаление подписчика.

Параметры

  • workflow_idstringобязательный
  • email_addressstringобязательный
  • accountany
remove_members_from_segment

Удаляет участников из статического сегмента или тега. Участники остаются в аудитории. Работает только со статическими сегментами (тегами), не с динамическими. Несуществующие участники из списка email тихо пропускаются. Используйте tag_member с tags_to_remove для удаления одного участника. Возвращает ошибку 404, если segment_id или list_id недействительны. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. segment_id: ID статического сегмента/тега (строка из цифр, например '12345'). Получить из list_segments. emails: Email-адреса для удаления через запятую (например 'a@co.com,b@co.com'). Возвращает: JSON с полями total_added (всегда 0), total_removed, errors (массив).

Удаляет участников из статического сегмента или тега. Участники остаются в аудитории. Работает только со статическими сегментами (тегами), не с динамическими. Несуществующие участники из списка email тихо пропускаются. Используйте tag_member с tags_to_remove для удаления одного участника. Возвращает ошибку 404, если segment_id или list_id недействительны. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. segment_id: ID статического сегмента/тега (строка из цифр, например '12345'). Получить из list_segments. emails: Email-адреса для удаления через запятую (например 'a@co.com,b@co.com'). Возвращает: JSON с полями total_added (всегда 0), total_removed, errors (массив).

Параметры

  • list_idstringобязательный
  • segment_idstringобязательный
  • emailsstringобязательный
  • accountany
replicate_campaign

Клонирует существующую кампанию в новый черновик с теми же настройками, получателями и содержимым. Используйте, чтобы взять успешную кампанию за основу. Работает с кампаниями любого статуса (черновик, запланирована, отправлена). Новая кампания создаётся со статусом 'save' (черновик). Используйте update_campaign и set_campaign_content, чтобы изменить копию перед отправкой. Используйте create_campaign, чтобы создать с нуля. Args: campaign_id: ID кампании для клонирования (например, 'abc123def4'). Получить из list_campaigns. Returns: JSON с полями: id (string, ID НОВОЙ кампании, отличается от оригинала), status ('save'), title (оригинальный заголовок с добавлением " (copy)"), web_id (int, для веб-интерфейса Mailchimp). Example: replicate_campaign(campaign_id="abc123") -> {"id": "def456", "status": "save", "title": "Spring Sale (copy)", "web_id": 789012}

Клонирует существующую кампанию в новый черновик с теми же настройками, получателями и содержимым. Используйте, чтобы взять успешную кампанию за основу. Работает с кампаниями любого статуса (черновик, запланирована, отправлена). Новая кампания создаётся со статусом 'save' (черновик). Используйте update_campaign и set_campaign_content, чтобы изменить копию перед отправкой. Используйте create_campaign, чтобы создать с нуля. Args: campaign_id: ID кампании для клонирования (например, 'abc123def4'). Получить из list_campaigns. Returns: JSON с полями: id (string, ID НОВОЙ кампании, отличается от оригинала), status ('save'), title (оригинальный заголовок с добавлением " (copy)"), web_id (int, для веб-интерфейса Mailchimp). Example: replicate_campaign(campaign_id="abc123") -> {"id": "def456", "status": "save", "title": "Spring Sale (copy)", "web_id": 789012}

Параметры

  • campaign_idstringобязательный
  • accountany
resend_to_non_openers

Создаёт новую черновую кампанию только для получателей, которые не открыли оригинальное письмо. Новая кампания наследует содержимое и настройки исходной. Не идемпотентно: повторный вызов создаёт два отдельных черновика. Последовательность: resend_to_non_openers -> update_campaign (изменить тему) -> send_campaign или schedule_campaign. Не использовать для A/B-тестов или кампаний, отправленных менее 24 часов назад (отслеживание открытий может быть неполным). Возвращает ошибку, если статус исходной кампании не 'sent'. Аргументы: campaign_id: ID исходной отправленной кампании (например 'abc123def4'). Получить из list_campaigns(status='sent'). Возвращает: JSON с полями id (ID новой кампании), status ('save'), title, web_id.

Создаёт новую черновую кампанию только для получателей, которые не открыли оригинальное письмо. Новая кампания наследует содержимое и настройки исходной. Не идемпотентно: повторный вызов создаёт два отдельных черновика. Последовательность: resend_to_non_openers -> update_campaign (изменить тему) -> send_campaign или schedule_campaign. Не использовать для A/B-тестов или кампаний, отправленных менее 24 часов назад (отслеживание открытий может быть неполным). Возвращает ошибку, если статус исходной кампании не 'sent'. Аргументы: campaign_id: ID исходной отправленной кампании (например 'abc123def4'). Получить из list_campaigns(status='sent'). Возвращает: JSON с полями id (ID новой кампании), status ('save'), title, web_id.

Параметры

  • campaign_idstringобязательный
  • accountany
resume_rss_campaign

Возобновляет приостановленную RSS-кампанию, чтобы она продолжила отправку запланированных выпусков. Используйте, чтобы перезапустить RSS-кампанию, ранее приостановленную с помощью pause_rss_campaign. Применяется только к кампаниям типа 'rss'. Для уточнения типа кампании используйте get_campaign_details. Аргументы: campaign_id: ID RSS-кампании для возобновления. Получить можно через list_campaigns или search_campaigns. Возвращает: JSON с ответом API, подтверждающим возобновление, или ошибку, если кампания не является RSS-кампанией.

Возобновляет приостановленную RSS-кампанию, чтобы она продолжила отправку запланированных выпусков. Используйте, чтобы перезапустить RSS-кампанию, ранее приостановленную с помощью pause_rss_campaign. Применяется только к кампаниям типа 'rss'. Для уточнения типа кампании используйте get_campaign_details. Аргументы: campaign_id: ID RSS-кампании для возобновления. Получить можно через list_campaigns или search_campaigns. Возвращает: JSON с ответом API, подтверждающим возобновление, или ошибку, если кампания не является RSS-кампанией.

Параметры

  • campaign_idstringобязательный
  • accountany
schedule_campaign

Запланировать черновик кампании для отправки в конкретное будущее время. Используйте для планирования доставки черновика кампании. У кампании должен быть задан контент через set_campaign_content, и она должна быть в статусе 'save'. Используйте unschedule_campaign, чтобы отменить запланированную отправку. Используйте send_campaign для немедленной доставки. Сначала используйте send_test_email для предварительного просмотра. Аргументы: campaign_id: ID кампании (например, 'abc123def4'). Должен быть в статусе 'save' с заданным контентом. schedule_time: Время отправки. Дата и время в формате ISO 8601 в UTC (например, '2025-06-15T14:00:00Z'). Должно быть не менее чем через 15 минут от текущего момента. Mailchimp округляет до ближайшей четверти часа. Возвращает: JSON с полями: status ("scheduled"), campaign_id, schedule_time. Возвращает ошибку, если у кампании нет контента или она не в статусе черновика. Пример: schedule_campaign(campaign_id="abc123", schedule_time="2025-06-15T14:00:00Z") -> {"status": "scheduled", "campaign_id": "abc123", "schedule_time": "2025-06-15T14:00:00Z"}

Запланировать черновик кампании для отправки в конкретное будущее время. Используйте для планирования доставки черновика кампании. У кампании должен быть задан контент через set_campaign_content, и она должна быть в статусе 'save'. Используйте unschedule_campaign, чтобы отменить запланированную отправку. Используйте send_campaign для немедленной доставки. Сначала используйте send_test_email для предварительного просмотра. Аргументы: campaign_id: ID кампании (например, 'abc123def4'). Должен быть в статусе 'save' с заданным контентом. schedule_time: Время отправки. Дата и время в формате ISO 8601 в UTC (например, '2025-06-15T14:00:00Z'). Должно быть не менее чем через 15 минут от текущего момента. Mailchimp округляет до ближайшей четверти часа. Возвращает: JSON с полями: status ("scheduled"), campaign_id, schedule_time. Возвращает ошибку, если у кампании нет контента или она не в статусе черновика. Пример: schedule_campaign(campaign_id="abc123", schedule_time="2025-06-15T14:00:00Z") -> {"status": "scheduled", "campaign_id": "abc123", "schedule_time": "2025-06-15T14:00:00Z"}

Параметры

  • campaign_idstringобязательный
  • schedule_timestringобязательный
  • accountany
search_automation_campaignsтолько чтение

Перечисляет кампании, созданные автоматизацией или Customer Journey (campaign type='automation'). Каждое письмо, которое Mailchimp отправляет из классической автоматизации или Customer Journey, создаёт объект кампании с типом `type='automation'`. Этот инструмент фильтрует `/campaigns` и показывает только такие кампании — то есть вы можете ответить на вопрос «что недавно отправили мои автоматизации?», не просматривая все кампании. Используйте это как самый практичный обходной путь при отсутствии публичного API для чтения Customer Journeys: сами journey вы перечислить не можете, но можете перечислить кампании, которые они порождают. `list_automations` отдаёт метаданные только для классических автоматизаций (внутренности journey не раскрыты). `list_campaigns` даёт полную ленту кампаний. Аргументы: - `count`: количество кампаний в ответе (1-1000, по умолчанию 20). - `offset`: смещение пагинации. Используйте, когда `total_items` превышает `count`. - `list_id`: опциональный идентификатор аудитории — ограничиться одной аудиторией. Получить из `list_audiences`. - `status`: фильтр по статусу кампании. Допустимые значения: `'save'`, `'paused'`, `'schedule'`, `'sending'`, `'sent'`. Опустите для всех статусов. - `since_send_time`: возвращать только кампании, отправленные после этой даты и времени в формате ISO 8601 (например, `'2026-04-01T00:00:00Z'`). - `before_send_time`: возвращать только кампании, отправленные до этой даты и времени в формате ISO 8601. Возвращает: JSON с `total_items` и массивом `campaigns`. Каждая кампания: `id`, `status`, `title`, `subject_line`, `send_time`, `emails_sent`, `list_id`, `list_name`. Пригодится, чтобы посчитать объём отправок автоматизаций и понять, какая автоматизация или journey создала какое письмо (по шаблонам в `title`).

Перечисляет кампании, созданные автоматизацией или Customer Journey (campaign type='automation'). Каждое письмо, которое Mailchimp отправляет из классической автоматизации или Customer Journey, создаёт объект кампании с типом `type='automation'`. Этот инструмент фильтрует `/campaigns` и показывает только такие кампании — то есть вы можете ответить на вопрос «что недавно отправили мои автоматизации?», не просматривая все кампании. Используйте это как самый практичный обходной путь при отсутствии публичного API для чтения Customer Journeys: сами journey вы перечислить не можете, но можете перечислить кампании, которые они порождают. `list_automations` отдаёт метаданные только для классических автоматизаций (внутренности journey не раскрыты). `list_campaigns` даёт полную ленту кампаний. Аргументы: - `count`: количество кампаний в ответе (1-1000, по умолчанию 20). - `offset`: смещение пагинации. Используйте, когда `total_items` превышает `count`. - `list_id`: опциональный идентификатор аудитории — ограничиться одной аудиторией. Получить из `list_audiences`. - `status`: фильтр по статусу кампании. Допустимые значения: `'save'`, `'paused'`, `'schedule'`, `'sending'`, `'sent'`. Опустите для всех статусов. - `since_send_time`: возвращать только кампании, отправленные после этой даты и времени в формате ISO 8601 (например, `'2026-04-01T00:00:00Z'`). - `before_send_time`: возвращать только кампании, отправленные до этой даты и времени в формате ISO 8601. Возвращает: JSON с `total_items` и массивом `campaigns`. Каждая кампания: `id`, `status`, `title`, `subject_line`, `send_time`, `emails_sent`, `list_id`, `list_name`. Пригодится, чтобы посчитать объём отправок автоматизаций и понять, какая автоматизация или journey создала какое письмо (по шаблонам в `title`).

Параметры

  • countinteger
  • offsetinteger
  • list_idany
  • statusany
  • since_send_timeany
  • before_send_timeany
  • accountany
search_campaignsтолько чтение

Ищет кампании по ключевым словам в заголовках, темах писем и названиях списков. Используйте, чтобы найти кампании, если вы не знаете их ID. Вместо этого используйте list_campaigns для просмотра по статусу или дате. Запросы короче 3 символов возвращают ошибку. Аргументы: query: Строка поиска (минимум 3 символа). Совпадение ищется по заголовкам кампаний, темам писем и названиям списков. count: Количество возвращаемых результатов (1-1000, по умолчанию 20). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом results. Каждый результат: объект кампании с полями id, type, status, title, subject_line, send_time, emails_sent.

Ищет кампании по ключевым словам в заголовках, темах писем и названиях списков. Используйте, чтобы найти кампании, если вы не знаете их ID. Вместо этого используйте list_campaigns для просмотра по статусу или дате. Запросы короче 3 символов возвращают ошибку. Аргументы: query: Строка поиска (минимум 3 символа). Совпадение ищется по заголовкам кампаний, темам писем и названиям списков. count: Количество возвращаемых результатов (1-1000, по умолчанию 20). offset: Смещение пагинации. Используйте, когда total_items превышает count. Возвращает: JSON с полями total_items и массивом results. Каждый результат: объект кампании с полями id, type, status, title, subject_line, send_time, emails_sent.

Параметры

  • querystringобязательный
  • countinteger
  • offsetinteger
  • accountany
search_membersтолько чтение

Ищет участников во всех аудиториях по email или имени — возвращает точные и нечёткие совпадения. Используйте, когда ищете конкретного человека и не знаете, к какой аудитории он относится. Чтобы просмотреть всех участников известной аудитории, используйте list_audience_members. После того как нашли участника, вызывайте get_member_activity или get_member_tags, чтобы получить данные о взаимодействии. Аргументы: query: Поисковый запрос. Полный email для точного совпадения, или имя/частичный email для нечёткого поиска. Минимум 3 символа. list_id: Опциональный идентификатор аудитории/списка, чтобы сузить поиск до одной аудитории. Получить из list_audiences. Возвращает: JSON с массивом results, объединяющим точные и нечёткие совпадения. Каждый результат: email, status ('subscribed', 'unsubscribed' и т.д.), full_name, list_id (аудитория, к которой относится участник). Точные совпадения идут первыми. Пример: search_members(query="john@example.com") -> {"results": [{"email": "john@example.com", "status": "subscribed", "list_id": "abc123", ...}]}

Ищет участников во всех аудиториях по email или имени — возвращает точные и нечёткие совпадения. Используйте, когда ищете конкретного человека и не знаете, к какой аудитории он относится. Чтобы просмотреть всех участников известной аудитории, используйте list_audience_members. После того как нашли участника, вызывайте get_member_activity или get_member_tags, чтобы получить данные о взаимодействии. Аргументы: query: Поисковый запрос. Полный email для точного совпадения, или имя/частичный email для нечёткого поиска. Минимум 3 символа. list_id: Опциональный идентификатор аудитории/списка, чтобы сузить поиск до одной аудитории. Получить из list_audiences. Возвращает: JSON с массивом results, объединяющим точные и нечёткие совпадения. Каждый результат: email, status ('subscribed', 'unsubscribed' и т.д.), full_name, list_id (аудитория, к которой относится участник). Точные совпадения идут первыми. Пример: search_members(query="john@example.com") -> {"results": [{"email": "john@example.com", "status": "subscribed", "list_id": "abc123", ...}]}

Параметры

  • querystringобязательный
  • list_idany
  • accountany
send_campaign

Отправляет кампанию всем целевым получателям немедленно. Письма начинают доставляться в течение нескольких минут. Используйте для немедленной отправки. Кампания должна иметь контент, заданный через set_campaign_content, и находиться в статусе 'save' (черновик). Для отправки в запланированное время используйте schedule_campaign. Сначала используйте send_test_email для предварительного просмотра письма перед отправкой реальным получателям. После отправки письма нельзя отозвать. Args: campaign_id: ID кампании для отправки (например, 'abc123def4'). Должна быть в статусе 'save' с заданным контентом. Получить можно из create_campaign или list_campaigns(status='save'). Returns: JSON с полями: status ("sent"), campaign_id. Возвращает ошибку, если у кампании нет контента, она уже отправлена или находится в статусе schedule (сначала используйте unschedule_campaign). Example: send_campaign(campaign_id="abc123") -> {"status": "sent", "campaign_id": "abc123"}

Отправляет кампанию всем целевым получателям немедленно. Письма начинают доставляться в течение нескольких минут. Используйте для немедленной отправки. Кампания должна иметь контент, заданный через set_campaign_content, и находиться в статусе 'save' (черновик). Для отправки в запланированное время используйте schedule_campaign. Сначала используйте send_test_email для предварительного просмотра письма перед отправкой реальным получателям. После отправки письма нельзя отозвать. Args: campaign_id: ID кампании для отправки (например, 'abc123def4'). Должна быть в статусе 'save' с заданным контентом. Получить можно из create_campaign или list_campaigns(status='save'). Returns: JSON с полями: status ("sent"), campaign_id. Возвращает ошибку, если у кампании нет контента, она уже отправлена или находится в статусе schedule (сначала используйте unschedule_campaign). Example: send_campaign(campaign_id="abc123") -> {"status": "sent", "campaign_id": "abc123"}

Параметры

  • campaign_idstringобязательный
  • accountany
send_test_email

Отправляет тестовое/предварительное письмо на указанные адреса, не затрагивая реальную аудиторию. Побочный эффект: отправляет реальное письмо. Тесты не учитываются в лимитах отправки и не отслеживаются в отчётах. У кампании должен быть задан контент через set_campaign_content. Рекомендуется перед вызовом send_campaign или schedule_campaign. Аргументы: campaign_id: Идентификатор кампании (например, 'abc123def4'). Контент должен быть задан. test_emails: Email-адреса через запятую (например, 'me@co.com,team@co.com'). Не более 10 за запрос. send_type: Формат: 'html' (по умолчанию) или 'plaintext'. Возвращает: JSON со статусом ("test_sent"), campaign_id и массивом test_emails. Ошибка, если контент не задан.

Отправляет тестовое/предварительное письмо на указанные адреса, не затрагивая реальную аудиторию. Побочный эффект: отправляет реальное письмо. Тесты не учитываются в лимитах отправки и не отслеживаются в отчётах. У кампании должен быть задан контент через set_campaign_content. Рекомендуется перед вызовом send_campaign или schedule_campaign. Аргументы: campaign_id: Идентификатор кампании (например, 'abc123def4'). Контент должен быть задан. test_emails: Email-адреса через запятую (например, 'me@co.com,team@co.com'). Не более 10 за запрос. send_type: Формат: 'html' (по умолчанию) или 'plaintext'. Возвращает: JSON со статусом ("test_sent"), campaign_id и массивом test_emails. Ошибка, если контент не задан.

Параметры

  • campaign_idstringобязательный
  • test_emailsstringобязательный
  • send_typestring
  • accountany
set_campaign_content

Устанавливает полный HTML-код тела черновика кампании, полностью заменяя всё текущее содержимое. Используйте после create_campaign, чтобы добавить письмо перед отправкой. Кампания должна быть в статусе 'save' (черновик). Затирает всё предыдущее содержимое. Типовой порядок действий: create_campaign -> set_campaign_content -> send_test_email -> send_campaign. Чтобы менять настройки (тему, отправителя) вместо содержимого, используйте update_campaign. Args: campaign_id: ID кампании (например, 'abc123def4'). Получить из create_campaign или list_campaigns(status='save'). html: Полный HTML-код тела письма. Обязательно валидный HTML. Для совместимости с почтовыми клиентами используйте встроенные CSS-стили. Поддерживаются merge-теги Mailchimp (например, *|FNAME|*, *|UNSUB|*). Крупные HTML-нагрузки могут приводить к тайм-ауту — держите объём до 200 КБ. Returns: JSON с полями: status ("content_set"), campaign_id. Возвращает ошибку, если кампания не в статусе черновика. Пример: set_campaign_content(campaign_id="abc123", html="<html><body><h1>Hello *|FNAME|*!</h1></body></html>") -> {"status": "content_set", "campaign_id": "abc123"}

Устанавливает полный HTML-код тела черновика кампании, полностью заменяя всё текущее содержимое. Используйте после create_campaign, чтобы добавить письмо перед отправкой. Кампания должна быть в статусе 'save' (черновик). Затирает всё предыдущее содержимое. Типовой порядок действий: create_campaign -> set_campaign_content -> send_test_email -> send_campaign. Чтобы менять настройки (тему, отправителя) вместо содержимого, используйте update_campaign. Args: campaign_id: ID кампании (например, 'abc123def4'). Получить из create_campaign или list_campaigns(status='save'). html: Полный HTML-код тела письма. Обязательно валидный HTML. Для совместимости с почтовыми клиентами используйте встроенные CSS-стили. Поддерживаются merge-теги Mailchimp (например, *|FNAME|*, *|UNSUB|*). Крупные HTML-нагрузки могут приводить к тайм-ауту — держите объём до 200 КБ. Returns: JSON с полями: status ("content_set"), campaign_id. Возвращает ошибку, если кампания не в статусе черновика. Пример: set_campaign_content(campaign_id="abc123", html="<html><body><h1>Hello *|FNAME|*!</h1></body></html>") -> {"status": "content_set", "campaign_id": "abc123"}

Параметры

  • campaign_idstringобязательный
  • htmlstringобязательный
  • accountany
start_automation

Запускает или возобновляет все письма в автоматизации, включая доставку подписчикам в очереди. Используйте, чтобы активировать новую автоматизацию или возобновить приостановленную. Подписчики из очереди начинают получать письма. Используйте pause_automation для временной остановки. Используйте list_automations для проверки текущего статуса. Аргументы: automation_id: ID рабочего процесса автоматизации (например 'auto123'). Получить из list_automations. Возвращает: JSON с полями: status ("started"), automation_id. Возвращает ошибку, если автоматизация уже отправляет письма или находится в статусе черновика. Пример: start_automation(automation_id="auto123") -> {"status": "started", "automation_id": "auto123"}

Запускает или возобновляет все письма в автоматизации, включая доставку подписчикам в очереди. Используйте, чтобы активировать новую автоматизацию или возобновить приостановленную. Подписчики из очереди начинают получать письма. Используйте pause_automation для временной остановки. Используйте list_automations для проверки текущего статуса. Аргументы: automation_id: ID рабочего процесса автоматизации (например 'auto123'). Получить из list_automations. Возвращает: JSON с полями: status ("started"), automation_id. Возвращает ошибку, если автоматизация уже отправляет письма или находится в статусе черновика. Пример: start_automation(automation_id="auto123") -> {"status": "started", "automation_id": "auto123"}

Параметры

  • automation_idstringобязательный
  • accountany
start_automation_email

Запускает конкретное письмо в классическом автоматизированном workflow. Возобновляет отправку одного автоматизированного письма, которое было ранее приостановлено. Очередные подписчики снова начинают получать письмо по расписанию workflow. Аргументы: workflow_id: Уникальный идентификатор классического автоматизированного workflow. workflow_email_id: Уникальный идентификатор автоматизированного письма для запуска. Возвращает: JSON, подтверждающий запуск.

Запускает конкретное письмо в классическом автоматизированном workflow. Возобновляет отправку одного автоматизированного письма, которое было ранее приостановлено. Очередные подписчики снова начинают получать письмо по расписанию workflow. Аргументы: workflow_id: Уникальный идентификатор классического автоматизированного workflow. workflow_email_id: Уникальный идентификатор автоматизированного письма для запуска. Возвращает: JSON, подтверждающий запуск.

Параметры

  • workflow_idstringобязательный
  • workflow_email_idstringобязательный
  • accountany
tag_memberидемпотентный

Добавляет или удаляет теги у одного участника. Не изменяет данные профиля или статус подписки. Теги — это регистронезависимые произвольные метки. Добавляемые теги создаются автоматически, если их нет; удаляемые теги игнорируются, если отсутствуют. Идемпотентно. Выберите подходящий инструмент для работы с участниками: tag_member для изменений тегов у конкретного участника, add_members_to_segment для массового добавления участников в тег/сегмент, add_member с параметром tags для назначения тегов при регистрации, update_member для изменений профиля/статуса, get_member_tags для проверки текущих тегов. Возвращает ошибку 404, если участник не существует. Аргументы: list_id: ID списка/аудитории (10-значный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. email_address: Email участника. Должен существовать в аудитории. tags_to_add: Имена тегов для добавления через запятую (например 'VIP,Постоянный клиент'). tags_to_remove: Имена тегов для удаления через запятую (например 'Пробный'). Возвращает: JSON со статусом ("updated"), email_address, массивом тегов с именем и статусом 'active'/'inactive'.

Добавляет или удаляет теги у одного участника. Не изменяет данные профиля или статус подписки. Теги — это регистронезависимые произвольные метки. Добавляемые теги создаются автоматически, если их нет; удаляемые теги игнорируются, если отсутствуют. Идемпотентно. Выберите подходящий инструмент для работы с участниками: tag_member для изменений тегов у конкретного участника, add_members_to_segment для массового добавления участников в тег/сегмент, add_member с параметром tags для назначения тегов при регистрации, update_member для изменений профиля/статуса, get_member_tags для проверки текущих тегов. Возвращает ошибку 404, если участник не существует. Аргументы: list_id: ID списка/аудитории (10-значный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. email_address: Email участника. Должен существовать в аудитории. tags_to_add: Имена тегов для добавления через запятую (например 'VIP,Постоянный клиент'). tags_to_remove: Имена тегов для удаления через запятую (например 'Пробный'). Возвращает: JSON со статусом ("updated"), email_address, массивом тегов с именем и статусом 'active'/'inactive'.

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • tags_to_addany
  • tags_to_removeany
  • accountany
trigger_customer_journey

Переводит контакт на конкретный этап воронки Customer Journey. Побочный эффект: контакт начинает получать письма путешествия немедленно. Контакт должен быть подписанным участником аудитории путешествия. Используйте list_automations, чтобы найти ID путешествий. Для Classic Automations используйте start_automation. Для разовых писем используйте send_campaign или create_campaign. Возвращает ошибку, если контакт не подписан или этап не является точкой входа, управляемой через API. Аргументы: journey_id: ID Customer Journey. Находится в веб-интерфейсе Mailchimp или через list_automations. step_id: ID этапа, на который нужно перевести. Должен быть точкой входа API-trigger. email_address: Email контакта. Должен быть подписан в аудитории путешествия. Возвращает: JSON со статусом ('triggered'), journey_id, step_id, email_address.

Переводит контакт на конкретный этап воронки Customer Journey. Побочный эффект: контакт начинает получать письма путешествия немедленно. Контакт должен быть подписанным участником аудитории путешествия. Используйте list_automations, чтобы найти ID путешествий. Для Classic Automations используйте start_automation. Для разовых писем используйте send_campaign или create_campaign. Возвращает ошибку, если контакт не подписан или этап не является точкой входа, управляемой через API. Аргументы: journey_id: ID Customer Journey. Находится в веб-интерфейсе Mailchimp или через list_automations. step_id: ID этапа, на который нужно перевести. Должен быть точкой входа API-trigger. email_address: Email контакта. Должен быть подписан в аудитории путешествия. Возвращает: JSON со статусом ('triggered'), journey_id, step_id, email_address.

Параметры

  • journey_idstringобязательный
  • step_idstringобязательный
  • email_addressstringобязательный
  • accountany
unpublish_landing_page

Отключает опубликованную лендинг-страницу. Публичный URL перестаёт отдавать страницу. Обратимо — повторно опубликуйте через publish_landing_page. Используйте delete_landing_page для полного удаления вместо этого. Возвращает ошибку 404, если page_id некорректен. Аргументы: page_id: ID лендинг-страницы для отключения. Получить из list_landing_pages. Возвращает: JSON со статусом ('unpublished') и page_id в случае успеха.

Отключает опубликованную лендинг-страницу. Публичный URL перестаёт отдавать страницу. Обратимо — повторно опубликуйте через publish_landing_page. Используйте delete_landing_page для полного удаления вместо этого. Возвращает ошибку 404, если page_id некорректен. Аргументы: page_id: ID лендинг-страницы для отключения. Получить из list_landing_pages. Возвращает: JSON со статусом ('unpublished') и page_id в случае успеха.

Параметры

  • page_idstringобязательный
  • accountany
unpublish_survey

Отменяет публикацию активного опроса, переводя его в офлайн. Используйте list_surveys, чтобы найти survey_id и убедиться, что опрос опубликован. Используйте publish_survey, чтобы снова сделать его активным. Аргументы: list_id: ID аудитории/списка (из list_audiences). survey_id: ID опроса (из list_surveys). Возвращает: JSON со статусом 'unpublished' и survey_id, или объект ошибки.

Отменяет публикацию активного опроса, переводя его в офлайн. Используйте list_surveys, чтобы найти survey_id и убедиться, что опрос опубликован. Используйте publish_survey, чтобы снова сделать его активным. Аргументы: list_id: ID аудитории/списка (из list_audiences). survey_id: ID опроса (из list_surveys). Возвращает: JSON со статусом 'unpublished' и survey_id, или объект ошибки.

Параметры

  • list_idstringобязательный
  • survey_idstringобязательный
  • accountany
unschedule_campaign

Отменяет запланированную отправку кампании и возвращает её в статус черновика ('save') для редактирования. Используйте, чтобы отменить запланированную отправку до того, как она будет выполнена. Работает только с кампаниями в статусе 'schedule'; возвращает ошибку для черновиков или уже отправленных кампаний. После отмены планирования кампанию можно редактировать через update_campaign/set_campaign_content и запланировать заново. Аргументы: campaign_id: ID кампании для отмены планирования (например, 'abc123def4'). Должен быть в статусе 'schedule'. Получить можно через list_campaigns(status='schedule'). Возвращает: JSON с полями: status ("unscheduled"), campaign_id. Возвращает ошибку, если кампания в данный момент не запланирована. Пример: unschedule_campaign(campaign_id="abc123") -> {"status": "unscheduled", "campaign_id": "abc123"}

Отменяет запланированную отправку кампании и возвращает её в статус черновика ('save') для редактирования. Используйте, чтобы отменить запланированную отправку до того, как она будет выполнена. Работает только с кампаниями в статусе 'schedule'; возвращает ошибку для черновиков или уже отправленных кампаний. После отмены планирования кампанию можно редактировать через update_campaign/set_campaign_content и запланировать заново. Аргументы: campaign_id: ID кампании для отмены планирования (например, 'abc123def4'). Должен быть в статусе 'schedule'. Получить можно через list_campaigns(status='schedule'). Возвращает: JSON с полями: status ("unscheduled"), campaign_id. Возвращает ошибку, если кампания в данный момент не запланирована. Пример: unschedule_campaign(campaign_id="abc123") -> {"status": "unscheduled", "campaign_id": "abc123"}

Параметры

  • campaign_idstringобязательный
  • accountany
unsubscribe_member

Отписывает участника от аудитории, сохраняя профиль и историю для отчётности. Операция обратима через update_member(status='subscribed'). Для полного удаления (в соответствии с GDPR) используйте delete_member. Возвращает ошибку 404, если участник не существует. Аргументы: list_id: идентификатор аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить можно через list_audiences. email_address: email участника. Должен быть корректным и существовать в аудитории. Возвращает: JSON с полями email_address и status ("unsubscribed").

Отписывает участника от аудитории, сохраняя профиль и историю для отчётности. Операция обратима через update_member(status='subscribed'). Для полного удаления (в соответствии с GDPR) используйте delete_member. Возвращает ошибку 404, если участник не существует. Аргументы: list_id: идентификатор аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить можно через list_audiences. email_address: email участника. Должен быть корректным и существовать в аудитории. Возвращает: JSON с полями email_address и status ("unsubscribed").

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • accountany
update_audience

Обновить настройки уровня аудитории: имя, отправитель по умолчанию, тема и напоминание о разрешении. Изменения применяются только к новым кампаниям — уже существующие не затрагиваются. Обновляются только переданные поля. Используйте get_audience_details, чтобы проверить текущие настройки. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, напр. 'abc123def4'). Получить из list_audiences. name: Новое отображаемое имя аудитории (показывается в интерфейсе Mailchimp и в выборе аудитории). from_name: Имя отправителя по умолчанию для новых кампаний (напр. 'Marketing Team'). Не более 100 символов. from_email: Email отправителя по умолчанию. Должен быть верифицированным доменом отправки в Mailchimp. subject: Тема письма по умолчанию для новых кампаний (напр. 'Monthly Update'). Не более 150 символов. permission_reminder: Почему подписчики получают письма (требуется по CAN-SPAM). Возвращает: JSON с id, name, permission_reminder, campaign_defaults (from_name, from_email, subject, language).

Обновить настройки уровня аудитории: имя, отправитель по умолчанию, тема и напоминание о разрешении. Изменения применяются только к новым кампаниям — уже существующие не затрагиваются. Обновляются только переданные поля. Используйте get_audience_details, чтобы проверить текущие настройки. Аргументы: list_id: ID аудитории/списка (10-символьный буквенно-цифровой, напр. 'abc123def4'). Получить из list_audiences. name: Новое отображаемое имя аудитории (показывается в интерфейсе Mailchimp и в выборе аудитории). from_name: Имя отправителя по умолчанию для новых кампаний (напр. 'Marketing Team'). Не более 100 символов. from_email: Email отправителя по умолчанию. Должен быть верифицированным доменом отправки в Mailchimp. subject: Тема письма по умолчанию для новых кампаний (напр. 'Monthly Update'). Не более 150 символов. permission_reminder: Почему подписчики получают письма (требуется по CAN-SPAM). Возвращает: JSON с id, name, permission_reminder, campaign_defaults (from_name, from_email, subject, language).

Параметры

  • list_idstringобязательный
  • nameany
  • from_nameany
  • from_emailany
  • subjectany
  • permission_reminderany
  • accountany
update_batch_webhook

Обновляет целевой URL существующего batch-вебхука. Используйте, чтобы перенаправить существующий batch-вебхук на новый URL обратного вызова. Чтобы найти batch_webhook_id, используйте list_batch_webhooks, а для удаления вебхука — delete_batch_webhook. Возвращает ошибку 404, если batch_webhook_id недействителен. Аргументы: batch_webhook_id: ID batch-вебхука для обновления. Получить из list_batch_webhooks. url: Новый URL обратного вызова, на который Mailchimp отправит POST-запрос после завершения batch-обработки. Возвращает: JSON с полями id, url, enabled (булево). Возвращает объект ошибки, если входные данные отклонены.

Обновляет целевой URL существующего batch-вебхука. Используйте, чтобы перенаправить существующий batch-вебхук на новый URL обратного вызова. Чтобы найти batch_webhook_id, используйте list_batch_webhooks, а для удаления вебхука — delete_batch_webhook. Возвращает ошибку 404, если batch_webhook_id недействителен. Аргументы: batch_webhook_id: ID batch-вебхука для обновления. Получить из list_batch_webhooks. url: Новый URL обратного вызова, на который Mailchimp отправит POST-запрос после завершения batch-обработки. Возвращает: JSON с полями id, url, enabled (булево). Возвращает объект ошибки, если входные данные отклонены.

Параметры

  • batch_webhook_idstringобязательный
  • urlstringобязательный
  • accountany
update_campaign

Обновляет настройки или сегментную таргетировку существующего черновика рассылки. Используйте, чтобы изменить тему письма, отправителя или сегментную таргетировку перед отправкой. Работает только с рассылками в статусе 'save' (черновик); возвращает ошибку для отправленных или запланированных рассылок. Обновляются только переданные поля; пропущенные поля остаются без изменений. Чтобы изменить HTML-тело письма, используйте set_campaign_content. Аргументы: campaign_id: ID рассылки для обновления (например, 'abc123def4'). Получите из list_campaigns или create_campaign. subject_line: Новая тема письма. title: Новое внутреннее название для организации в Mailchimp. preview_text: Новый текст превью/прехеадера. from_name: Новое имя отправителя. reply_to: Новый email для ответа. Должен быть с подтверждённого домена. list_id: ID аудитории/списка. Обязателен при изменении segment_id. Получите из list_audiences. segment_id: ID сохранённого сегмента для таргетирования. Требует также указать list_id. Получите из list_segments. Возвращает: JSON с полями: id, status, settings (полный объект настроек), recipients (list_id, segment_opts). Пример: update_campaign(campaign_id="abc123", subject_line="Updated Subject") -> {"id": "abc123", "status": "save", "settings": {"subject_line": "Updated Subject", ...}}

Обновляет настройки или сегментную таргетировку существующего черновика рассылки. Используйте, чтобы изменить тему письма, отправителя или сегментную таргетировку перед отправкой. Работает только с рассылками в статусе 'save' (черновик); возвращает ошибку для отправленных или запланированных рассылок. Обновляются только переданные поля; пропущенные поля остаются без изменений. Чтобы изменить HTML-тело письма, используйте set_campaign_content. Аргументы: campaign_id: ID рассылки для обновления (например, 'abc123def4'). Получите из list_campaigns или create_campaign. subject_line: Новая тема письма. title: Новое внутреннее название для организации в Mailchimp. preview_text: Новый текст превью/прехеадера. from_name: Новое имя отправителя. reply_to: Новый email для ответа. Должен быть с подтверждённого домена. list_id: ID аудитории/списка. Обязателен при изменении segment_id. Получите из list_audiences. segment_id: ID сохранённого сегмента для таргетирования. Требует также указать list_id. Получите из list_segments. Возвращает: JSON с полями: id, status, settings (полный объект настроек), recipients (list_id, segment_opts). Пример: update_campaign(campaign_id="abc123", subject_line="Updated Subject") -> {"id": "abc123", "status": "save", "settings": {"subject_line": "Updated Subject", ...}}

Параметры

  • campaign_idstringобязательный
  • subject_lineany
  • titleany
  • preview_textany
  • from_nameany
  • reply_toany
  • list_idany
  • segment_idany
  • accountany
update_campaign_feedback

Обновляет текст существующего комментария обратной связи в кампании. Используйте, чтобы отредактировать ранее оставленное примечание о сотрудничестве. Чтобы найти идентификаторы обратной связи, используйте list_campaign_feedback. Аргументы: campaign_id: ID кампании, к которой относится обратная связь. Получить из list_campaigns. feedback_id: ID комментария обратной связи для обновления. Получить из list_campaign_feedback. message: Новый текст комментария, заменяющий предыдущее сообщение. Возвращает: JSON с полями feedback_id, message, is_complete, block_id, updated_at.

Обновляет текст существующего комментария обратной связи в кампании. Используйте, чтобы отредактировать ранее оставленное примечание о сотрудничестве. Чтобы найти идентификаторы обратной связи, используйте list_campaign_feedback. Аргументы: campaign_id: ID кампании, к которой относится обратная связь. Получить из list_campaigns. feedback_id: ID комментария обратной связи для обновления. Получить из list_campaign_feedback. message: Новый текст комментария, заменяющий предыдущее сообщение. Возвращает: JSON с полями feedback_id, message, is_complete, block_id, updated_at.

Параметры

  • campaign_idstringобязательный
  • feedback_idstringобязательный
  • messagestringобязательный
  • accountany
update_campaign_folder

Переименовать существующую папку кампании. Используется для обновления отображаемого имени папки; кампании, назначенные на эту папку, не затрагиваются. Используйте list_campaign_folders, чтобы узнать ID папок. Аргументы: folder_id: ID папки кампании для обновления. Получить из list_campaign_folders. name: Новое отображаемое имя для папки. Возвращает: JSON с id, name и количеством кампаний в папке.

Переименовать существующую папку кампании. Используется для обновления отображаемого имени папки; кампании, назначенные на эту папку, не затрагиваются. Используйте list_campaign_folders, чтобы узнать ID папок. Аргументы: folder_id: ID папки кампании для обновления. Получить из list_campaign_folders. name: Новое отображаемое имя для папки. Возвращает: JSON с id, name и количеством кампаний в папке.

Параметры

  • folder_idstringобязательный
  • namestringобязательный
  • accountany
update_landing_page

Обновляет настройки существующей лендинг-страницы. Меняются только переданные поля. Нельзя изменить list_id или template после создания; вместо этого создайте новую страницу. Используйте publish_landing_page / unpublish_landing_page, чтобы изменить статус публикации. Используйте get_landing_page, чтобы просмотреть текущие настройки перед обновлением. Возвращает ошибку 404, если page_id недействителен. Аргументы: page_id: ID лендинг-страницы. Получите из list_landing_pages. name: Новое внутреннее название. title: Новый заголовок вкладки браузера. description: Новое внутреннее описание. tracking_opens: Включение/выключение отслеживания открытий. tracking_clicks: Включение/выключение отслеживания кликов. Возвращает: JSON с полями id, name, title, status, url, updated_at, list_id.

Обновляет настройки существующей лендинг-страницы. Меняются только переданные поля. Нельзя изменить list_id или template после создания; вместо этого создайте новую страницу. Используйте publish_landing_page / unpublish_landing_page, чтобы изменить статус публикации. Используйте get_landing_page, чтобы просмотреть текущие настройки перед обновлением. Возвращает ошибку 404, если page_id недействителен. Аргументы: page_id: ID лендинг-страницы. Получите из list_landing_pages. name: Новое внутреннее название. title: Новый заголовок вкладки браузера. description: Новое внутреннее описание. tracking_opens: Включение/выключение отслеживания открытий. tracking_clicks: Включение/выключение отслеживания кликов. Возвращает: JSON с полями id, name, title, status, url, updated_at, list_id.

Параметры

  • page_idstringобязательный
  • nameany
  • titleany
  • descriptionany
  • tracking_opensany
  • tracking_clicksany
  • accountany
update_memberидемпотентный

Обновляет поля профиля или статус подписки участника. Не управляет тегами. Обновляются только переданные поля; пропущенные поля остаются без изменений. Идемпотентно: повторное применение тех же значений безопасно. Побочный эффект: смена статуса на 'pending' отправляет письмо для повторного подтверждения. Выбирайте подходящий инструмент для работы с участниками: update_member для изменения профиля/статуса, tag_member для управления тегами, unsubscribe_member как быстрый способ отписки, add_member если контакт ещё не существует, batch_subscribe для массовых операций. Возвращает ошибку 404, если участник не существует. Возвращает 400, если переход статуса недопустим (например, с cleaned на subscribed). Аргументы: list_id: Идентификатор аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. email_address: Email участника для обновления. Должен существовать в аудитории. status: Новый статус: 'subscribed', 'unsubscribed', 'cleaned', 'pending'. first_name: Новое имя (поле слияния FNAME). last_name: Новая фамилия (поле слияния LNAME). Возвращает: JSON с id, email_address, status, full_name.

Обновляет поля профиля или статус подписки участника. Не управляет тегами. Обновляются только переданные поля; пропущенные поля остаются без изменений. Идемпотентно: повторное применение тех же значений безопасно. Побочный эффект: смена статуса на 'pending' отправляет письмо для повторного подтверждения. Выбирайте подходящий инструмент для работы с участниками: update_member для изменения профиля/статуса, tag_member для управления тегами, unsubscribe_member как быстрый способ отписки, add_member если контакт ещё не существует, batch_subscribe для массовых операций. Возвращает ошибку 404, если участник не существует. Возвращает 400, если переход статуса недопустим (например, с cleaned на subscribed). Аргументы: list_id: Идентификатор аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. email_address: Email участника для обновления. Должен существовать в аудитории. status: Новый статус: 'subscribed', 'unsubscribed', 'cleaned', 'pending'. first_name: Новое имя (поле слияния FNAME). last_name: Новая фамилия (поле слияния LNAME). Возвращает: JSON с id, email_address, status, full_name.

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • statusany
  • first_nameany
  • last_nameany
  • accountany
update_member_note

Обновляет текст существующей заметки участника. Заменяет всё содержимое заметки. Используйте list_member_notes, чтобы найти note_id. Вместо перезаписи используйте add_member_note для создания новой заметки; delete_member_note — для удаления заметки. Возвращает 404, если заметка или участник не существует. Аргументы: list_id: идентификатор аудитории/списка. Получить из list_audiences. email_address: email участника, владельца заметки. note_id: идентификатор заметки для обновления. Получить из list_member_notes. note: новый текст заметки (макс. 1000 символов). Полностью заменяет предыдущий текст. Возвращает: JSON с полями id, email_address, note (новое значение), updated_at.

Обновляет текст существующей заметки участника. Заменяет всё содержимое заметки. Используйте list_member_notes, чтобы найти note_id. Вместо перезаписи используйте add_member_note для создания новой заметки; delete_member_note — для удаления заметки. Возвращает 404, если заметка или участник не существует. Аргументы: list_id: идентификатор аудитории/списка. Получить из list_audiences. email_address: email участника, владельца заметки. note_id: идентификатор заметки для обновления. Получить из list_member_notes. note: новый текст заметки (макс. 1000 символов). Полностью заменяет предыдущий текст. Возвращает: JSON с полями id, email_address, note (новое значение), updated_at.

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • note_idstringобязательный
  • notestringобязательный
  • accountany
update_merge_field

Обновляет имя поля слияния, значение по умолчанию, флаг обязательности или варианты выпадающего списка/радиокнопок. Обновляются только переданные поля; пропущенные поля остаются без изменений. Варианты заменяются полностью (старые варианты теряются). Не используйте для изменения типа поля или тега (неизменяемы после создания); вместо этого удалите поле слияния, а затем создайте новое. Возвращает ошибку 404, если merge_id недействителен или не существует. Аргументы: list_id: ID аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получите из list_audiences. merge_id: ID поля слияния (числовая строка, например '5'). Получите из list_merge_fields. name: Новое отображаемое имя поля. required: Обязательно ли поле при подписке. default_value: Новое значение по умолчанию для новых подписчиков. choices: Варианты через запятую для типов выпадающий список/радиокнопки (например 'Small,Medium,Large'). Заменяет все существующие варианты. Игнорируется для других типов полей. Возвращает: JSON с полями merge_id, tag, name, type, required.

Обновляет имя поля слияния, значение по умолчанию, флаг обязательности или варианты выпадающего списка/радиокнопок. Обновляются только переданные поля; пропущенные поля остаются без изменений. Варианты заменяются полностью (старые варианты теряются). Не используйте для изменения типа поля или тега (неизменяемы после создания); вместо этого удалите поле слияния, а затем создайте новое. Возвращает ошибку 404, если merge_id недействителен или не существует. Аргументы: list_id: ID аудитории/списка (10-значный буквенно-цифровой, например 'abc123def4'). Получите из list_audiences. merge_id: ID поля слияния (числовая строка, например '5'). Получите из list_merge_fields. name: Новое отображаемое имя поля. required: Обязательно ли поле при подписке. default_value: Новое значение по умолчанию для новых подписчиков. choices: Варианты через запятую для типов выпадающий список/радиокнопки (например 'Small,Medium,Large'). Заменяет все существующие варианты. Игнорируется для других типов полей. Возвращает: JSON с полями merge_id, tag, name, type, required.

Параметры

  • list_idstringобязательный
  • merge_idstringобязательный
  • nameany
  • requiredany
  • default_valueany
  • choicesany
  • accountany
update_promo_code

Обновляет строку промокода, URL редиректа или статус активности. Нельзя перенести код в другое правило — удалите и создайте заново. Типичный сценарий: установите enabled=false, чтобы временно отключить код после окончания кампании, не удаляя историю активаций. Возвращает 404, если store_id, promo_rule_id или promo_code_id некорректны. Аргументы: store_id: ID интернет-магазина. promo_rule_id: ID правила, к которому привязан код. promo_code_id: ID кода для обновления. code: Новое значение кода (без учёта регистра). redemption_url: Новый URL редиректа. enabled: Включить/отключить код. Возвращает: JSON с полями id, code, redemption_url, enabled, updated_at.

Обновляет строку промокода, URL редиректа или статус активности. Нельзя перенести код в другое правило — удалите и создайте заново. Типичный сценарий: установите enabled=false, чтобы временно отключить код после окончания кампании, не удаляя историю активаций. Возвращает 404, если store_id, promo_rule_id или promo_code_id некорректны. Аргументы: store_id: ID интернет-магазина. promo_rule_id: ID правила, к которому привязан код. promo_code_id: ID кода для обновления. code: Новое значение кода (без учёта регистра). redemption_url: Новый URL редиректа. enabled: Включить/отключить код. Возвращает: JSON с полями id, code, redemption_url, enabled, updated_at.

Параметры

  • store_idstringобязательный
  • promo_rule_idstringобязательный
  • promo_code_idstringобязательный
  • codeany
  • redemption_urlany
  • enabledany
  • accountany
update_promo_rule

Обновить существующее правило промо. Меняются только переданные поля. Пригодится, чтобы включить/выключить правило (enabled), продлить дату окончания или изменить размер скидки в середине кампании. Используйте list_promo_rules, чтобы узнать promo_rule_ids. Возвращает 404, если store_id или promo_rule_id недействительны. Аргументы: store_id: ID магазина электронной коммерции. promo_rule_id: ID существующего правила. description: Новое внутреннее описание. amount: Новый размер скидки. type: Новый тип ('fixed' или 'percentage'). target: Новый объект ('per_item', 'total' или 'shipping'). enabled: Включить/выключить правило. title: Новое публичное название. starts_at: Новая дата начала (ISO 8601). ends_at: Новая дата окончания (ISO 8601). Возвращает: JSON с полями id, title, description, amount, type, target, enabled, updated_at.

Обновить существующее правило промо. Меняются только переданные поля. Пригодится, чтобы включить/выключить правило (enabled), продлить дату окончания или изменить размер скидки в середине кампании. Используйте list_promo_rules, чтобы узнать promo_rule_ids. Возвращает 404, если store_id или promo_rule_id недействительны. Аргументы: store_id: ID магазина электронной коммерции. promo_rule_id: ID существующего правила. description: Новое внутреннее описание. amount: Новый размер скидки. type: Новый тип ('fixed' или 'percentage'). target: Новый объект ('per_item', 'total' или 'shipping'). enabled: Включить/выключить правило. title: Новое публичное название. starts_at: Новая дата начала (ISO 8601). ends_at: Новая дата окончания (ISO 8601). Возвращает: JSON с полями id, title, description, amount, type, target, enabled, updated_at.

Параметры

  • store_idstringобязательный
  • promo_rule_idstringобязательный
  • descriptionany
  • amountany
  • typeany
  • targetany
  • enabledany
  • titleany
  • starts_atany
  • ends_atany
  • accountany
update_segmentидемпотентный

Обновляет имя сегмента или условия динамической фильтрации. Обновляются только указанные поля. Идемпотентно: повторное применение того же имени безопасно. Нельзя изменить сегмент со статического на динамический или наоборот. Используйте add_members_to_segment или remove_members_from_segment для управления составом статического сегмента. Возвращает ошибку 404, если segment_id недействителен. Указание match без conditions_json игнорируется. Аргументы: list_id: идентификатор аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. segment_id: идентификатор обновляемого сегмента (числовая строка, например '12345'). Получить из list_segments. name: новое отображаемое имя сегмента. match: тип соответствия для динамических сегментов: 'all' (И) или 'any' (ИЛИ). Должен быть указан вместе с conditions_json. conditions_json: JSON-строка с массивом условий. Должен быть указан с match. Возвращает: JSON с полями id, name, member_count, type ('static'/'saved'), options.

Обновляет имя сегмента или условия динамической фильтрации. Обновляются только указанные поля. Идемпотентно: повторное применение того же имени безопасно. Нельзя изменить сегмент со статического на динамический или наоборот. Используйте add_members_to_segment или remove_members_from_segment для управления составом статического сегмента. Возвращает ошибку 404, если segment_id недействителен. Указание match без conditions_json игнорируется. Аргументы: list_id: идентификатор аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. segment_id: идентификатор обновляемого сегмента (числовая строка, например '12345'). Получить из list_segments. name: новое отображаемое имя сегмента. match: тип соответствия для динамических сегментов: 'all' (И) или 'any' (ИЛИ). Должен быть указан вместе с conditions_json. conditions_json: JSON-строка с массивом условий. Должен быть указан с match. Возвращает: JSON с полями id, name, member_count, type ('static'/'saved'), options.

Параметры

  • list_idstringобязательный
  • segment_idstringобязательный
  • nameany
  • matchany
  • conditions_jsonany
  • accountany
update_store

Обновляет название, валюту, подключённую аудиторию или метаданные существующего магазина электронной коммерции. Изменяются только поля, указанные в additional_fields. Многие магазины синхронизируются автоматически через интеграции с Shopify или WooCommerce; эти ручные записи подходят для кастомных или headless витрин. Args: store_id: ID магазина электронной коммерции. additional_fields: Словарь документированных полей для обновления (например, name, currency_code, domain, email_address, primary_locale, timezone), объединяемых в тело запроса. Returns: JSON с обновлённым объектом магазина.

Обновляет название, валюту, подключённую аудиторию или метаданные существующего магазина электронной коммерции. Изменяются только поля, указанные в additional_fields. Многие магазины синхронизируются автоматически через интеграции с Shopify или WooCommerce; эти ручные записи подходят для кастомных или headless витрин. Args: store_id: ID магазина электронной коммерции. additional_fields: Словарь документированных полей для обновления (например, name, currency_code, domain, email_address, primary_locale, timezone), объединяемых в тело запроса. Returns: JSON с обновлённым объектом магазина.

Параметры

  • store_idstringобязательный
  • additional_fieldsany
  • accountany
update_store_cart

Обновляет итоговые суммы, валюту, URL оформления заказа или позиции существующей корзины. Изменяются только переданные поля. Чтобы заменить позиции, передайте полный массив lines_json (частичное обновление позиций через этот инструмент не поддерживается — для редактирования отдельных позиций используйте интерфейс Mailchimp или REST API напрямую). Возвращает 404, если store_id или cart_id недействительны. Аргументы: store_id: ID интернет-магазина. cart_id: ID существующей корзины. order_total: Новая общая сумма заказа. tax_total: Новая сумма налога. checkout_url: Новый URL оформления заказа. currency_code: Новый код валюты по ISO 4217. lines_json: JSON-строка с заменяющим массивом позиций. Возвращает: JSON с полями id, order_total, tax_total, checkout_url, currency_code, updated_at.

Обновляет итоговые суммы, валюту, URL оформления заказа или позиции существующей корзины. Изменяются только переданные поля. Чтобы заменить позиции, передайте полный массив lines_json (частичное обновление позиций через этот инструмент не поддерживается — для редактирования отдельных позиций используйте интерфейс Mailchimp или REST API напрямую). Возвращает 404, если store_id или cart_id недействительны. Аргументы: store_id: ID интернет-магазина. cart_id: ID существующей корзины. order_total: Новая общая сумма заказа. tax_total: Новая сумма налога. checkout_url: Новый URL оформления заказа. currency_code: Новый код валюты по ISO 4217. lines_json: JSON-строка с заменяющим массивом позиций. Возвращает: JSON с полями id, order_total, tax_total, checkout_url, currency_code, updated_at.

Параметры

  • store_idstringобязательный
  • cart_idstringобязательный
  • order_totalany
  • tax_totalany
  • checkout_urlany
  • currency_codeany
  • lines_jsonany
  • accountany
update_store_customer

Обновляет имя, статус согласия на рассылку, адрес или компанию существующего покупателя магазина. Изменяются только поля, переданные в additional_fields. Многие магазины синхронизируют покупателей автоматически через интеграции с Shopify или WooCommerce; эти ручные записи подходят для кастомных или headless витрин. Аргументы: - store_id: ID магазина электронной коммерции. - customer_id: ID существующего покупателя. - additional_fields: Словарь с задокументированными полями для обновления (например, opt_in_status, first_name, last_name, company, address), объединяется с телом запроса. Возвращает: JSON с обновлённым объектом покупателя.

Обновляет имя, статус согласия на рассылку, адрес или компанию существующего покупателя магазина. Изменяются только поля, переданные в additional_fields. Многие магазины синхронизируют покупателей автоматически через интеграции с Shopify или WooCommerce; эти ручные записи подходят для кастомных или headless витрин. Аргументы: - store_id: ID магазина электронной коммерции. - customer_id: ID существующего покупателя. - additional_fields: Словарь с задокументированными полями для обновления (например, opt_in_status, first_name, last_name, company, address), объединяется с телом запроса. Возвращает: JSON с обновлённым объектом покупателя.

Параметры

  • store_idstringобязательный
  • customer_idstringобязательный
  • additional_fieldsany
  • accountany
update_store_order

Обновляет поля существующего заказа в интернет-магазине. Изменяются только те поля, которые вы передаёте в additional_fields; пропустите поле, чтобы оставить его без изменений. Ручное обновление заказов подходит для кастомных / headless магазинов; интеграции с Shopify и WooCommerce синхронизируют заказы автоматически. Args: store_id: Идентификатор магазина электронной коммерции. Получите из list_ecommerce_stores. order_id: Существующий идентификатор заказа в магазине. additional_fields: Необязательный словарь полей заказа для обновления, объединяется с телом запроса (например, financial_status, fulfillment_status, order_total, shipping_total, currency_code). Returns: JSON с обновлённым объектом заказа.

Обновляет поля существующего заказа в интернет-магазине. Изменяются только те поля, которые вы передаёте в additional_fields; пропустите поле, чтобы оставить его без изменений. Ручное обновление заказов подходит для кастомных / headless магазинов; интеграции с Shopify и WooCommerce синхронизируют заказы автоматически. Args: store_id: Идентификатор магазина электронной коммерции. Получите из list_ecommerce_stores. order_id: Существующий идентификатор заказа в магазине. additional_fields: Необязательный словарь полей заказа для обновления, объединяется с телом запроса (например, financial_status, fulfillment_status, order_total, shipping_total, currency_code). Returns: JSON с обновлённым объектом заказа.

Параметры

  • store_idstringобязательный
  • order_idstringобязательный
  • additional_fieldsany
  • accountany
update_store_order_line

Обновляет позицию в существующем заказе электронной коммерции. Изменяются только те поля, которые вы передаёте в additional_fields; пропустите поле, чтобы оставить его без изменений. Manual Commerce подходит для кастомных/headless-магазинов; интеграции с Shopify и WooCommerce синхронизируют строки заказов автоматически. Аргументы: store_id: Идентификатор магазина электронной коммерции. Получите из list_ecommerce_stores. order_id: Идентификатор заказа, которому принадлежит строка. line_id: Идентификатор существующей позиции для обновления. additional_fields: Необязательный словарь полей строки для обновления, объединяется с телом (например, product_id, product_variant_id, quantity, price, discount). Возвращает: JSON с обновлённым объектом строки.

Обновляет позицию в существующем заказе электронной коммерции. Изменяются только те поля, которые вы передаёте в additional_fields; пропустите поле, чтобы оставить его без изменений. Manual Commerce подходит для кастомных/headless-магазинов; интеграции с Shopify и WooCommerce синхронизируют строки заказов автоматически. Аргументы: store_id: Идентификатор магазина электронной коммерции. Получите из list_ecommerce_stores. order_id: Идентификатор заказа, которому принадлежит строка. line_id: Идентификатор существующей позиции для обновления. additional_fields: Необязательный словарь полей строки для обновления, объединяется с телом (например, product_id, product_variant_id, quantity, price, discount). Возвращает: JSON с обновлённым объектом строки.

Параметры

  • store_idstringобязательный
  • order_idstringобязательный
  • line_idstringобязательный
  • additional_fieldsany
  • accountany
update_store_product

Обновляет название, описание, изображения или другие метаданные существующего товара. Изменяются только поля, переданные в additional_fields. Многие магазины синхронизируют товары автоматически через интеграции с Shopify или WooCommerce; такие ручные записи подходят для кастомных или headless витрин. Аргументы: store_id: Идентификатор магазина электронной коммерции. product_id: Идентификатор существующего товара. additional_fields: Словарь документированных полей для обновления (например, title, handle, url, description, type, vendor, image_url), объединяемый с телом запроса. Возвращает: JSON с обновлённым объектом товара.

Обновляет название, описание, изображения или другие метаданные существующего товара. Изменяются только поля, переданные в additional_fields. Многие магазины синхронизируют товары автоматически через интеграции с Shopify или WooCommerce; такие ручные записи подходят для кастомных или headless витрин. Аргументы: store_id: Идентификатор магазина электронной коммерции. product_id: Идентификатор существующего товара. additional_fields: Словарь документированных полей для обновления (например, title, handle, url, description, type, vendor, image_url), объединяемый с телом запроса. Возвращает: JSON с обновлённым объектом товара.

Параметры

  • store_idstringобязательный
  • product_idstringобязательный
  • additional_fieldsany
  • accountany
update_store_product_image

Обновляет изображение, прикрепленное к товару в интернет-магазине. Изменяются только поля, которые вы передаете в additional_fields; если поле опущено, оно остается без изменений. Ручная запись подходит для кастомных и headless-магазинов; интеграции с Shopify и WooCommerce синхронизируют изображения товаров автоматически. Аргументы: store_id: Идентификатор интернет-магазина. Получить из list_ecommerce_stores. product_id: Идентификатор товара, которому принадлежит изображение. image_id: Идентификатор существующего изображения для обновления. additional_fields: Необязательный словарь полей изображения для обновления, объединяется с телом запроса (например, url, variant_ids). Возвращает: JSON с обновленным объектом изображения.

Обновляет изображение, прикрепленное к товару в интернет-магазине. Изменяются только поля, которые вы передаете в additional_fields; если поле опущено, оно остается без изменений. Ручная запись подходит для кастомных и headless-магазинов; интеграции с Shopify и WooCommerce синхронизируют изображения товаров автоматически. Аргументы: store_id: Идентификатор интернет-магазина. Получить из list_ecommerce_stores. product_id: Идентификатор товара, которому принадлежит изображение. image_id: Идентификатор существующего изображения для обновления. additional_fields: Необязательный словарь полей изображения для обновления, объединяется с телом запроса (например, url, variant_ids). Возвращает: JSON с обновленным объектом изображения.

Параметры

  • store_idstringобязательный
  • product_idstringобязательный
  • image_idstringобязательный
  • additional_fieldsany
  • accountany
update_store_product_variant

Обновляет цену, артикул (SKU), остаток на складе или другие атрибуты существующего варианта товара. Меняются только поля, переданные в additional_fields. Многие магазины синхронизируют варианты автоматически через интеграции Shopify или WooCommerce; эти ручные записи подходят для кастомных или headless-витрин. Аргументы: store_id: Идентификатор магазина электронной коммерции. product_id: Идентификатор товара, которому принадлежит вариант. variant_id: Идентификатор существующего варианта. additional_fields: Словарь документированных полей для обновления (например, title, url, sku, price, inventory_quantity, image_url), объединяемый с телом запроса. Возвращает: JSON с обновлённым объектом варианта.

Обновляет цену, артикул (SKU), остаток на складе или другие атрибуты существующего варианта товара. Меняются только поля, переданные в additional_fields. Многие магазины синхронизируют варианты автоматически через интеграции Shopify или WooCommerce; эти ручные записи подходят для кастомных или headless-витрин. Аргументы: store_id: Идентификатор магазина электронной коммерции. product_id: Идентификатор товара, которому принадлежит вариант. variant_id: Идентификатор существующего варианта. additional_fields: Словарь документированных полей для обновления (например, title, url, sku, price, inventory_quantity, image_url), объединяемый с телом запроса. Возвращает: JSON с обновлённым объектом варианта.

Параметры

  • store_idstringобязательный
  • product_idstringобязательный
  • variant_idstringобязательный
  • additional_fieldsany
  • accountany
update_template

Обновляет имя или HTML-содержимое существующего шаблона. Обновляются только указанные поля. Работает только с шаблонами, созданными пользователем; шаблоны из галереи и базовые шаблоны изменить нельзя. Используйте create_template для создания нового шаблона вместо изменения шаблона из галереи. Возвращает ошибку 404, если template_id недействителен. Параметры: template_id: ID шаблона для обновления (числовая строка, например '12345'). Получить из list_templates. name: Новое отображаемое имя шаблона. html: Новое HTML-содержимое. Заменяет всё существующее содержимое. Возвращает: JSON с полями id, name, type, active, date_edited.

Обновляет имя или HTML-содержимое существующего шаблона. Обновляются только указанные поля. Работает только с шаблонами, созданными пользователем; шаблоны из галереи и базовые шаблоны изменить нельзя. Используйте create_template для создания нового шаблона вместо изменения шаблона из галереи. Возвращает ошибку 404, если template_id недействителен. Параметры: template_id: ID шаблона для обновления (числовая строка, например '12345'). Получить из list_templates. name: Новое отображаемое имя шаблона. html: Новое HTML-содержимое. Заменяет всё существующее содержимое. Возвращает: JSON с полями id, name, type, active, date_edited.

Параметры

  • template_idstringобязательный
  • nameany
  • htmlany
  • accountany
update_template_folder

Переименовывает существующую папку с шаблонами. Используется, чтобы обновить отображаемое имя папки; шаблоны, назначенные на эту папку, не затрагиваются. Чтобы узнать ID папок, используйте list_template_folders. Аргументы: folder_id: ID папки шаблонов для обновления. Получить из list_template_folders. name: Новое отображаемое имя папки. Возвращает: JSON с полями id, name и количеством шаблонов в папке.

Переименовывает существующую папку с шаблонами. Используется, чтобы обновить отображаемое имя папки; шаблоны, назначенные на эту папку, не затрагиваются. Чтобы узнать ID папок, используйте list_template_folders. Аргументы: folder_id: ID папки шаблонов для обновления. Получить из list_template_folders. name: Новое отображаемое имя папки. Возвращает: JSON с полями id, name и количеством шаблонов в папке.

Параметры

  • folder_idstringобязательный
  • namestringобязательный
  • accountany
upload_file

Загрузите новое изображение или файл в File Manager (в формате base64). Обеспечивает программный хостинг изображений для контента кампаний и шаблонов: загрузите сюда, затем используйте возвращённый full_size_url в вашем HTML. Используйте list_file_folders для выбора папки, list_files для просмотра существующих файлов и delete_file для удаления. Аргументы: name: Имя файла с расширением (например, 'hero.png'). Отображается в File Manager. file_data: Содержимое файла, закодированное в base64 (не URL и не сырые байты). folder_id: Необязательный ID папки (из list_file_folders), в которую загружать. Опустите для корневой папки. Возвращает: JSON с полями id (используйте как file_id), name, type, full_size_url (URL для встраивания), thumbnail_url, size, width, height, folder_id, created_at.

Загрузите новое изображение или файл в File Manager (в формате base64). Обеспечивает программный хостинг изображений для контента кампаний и шаблонов: загрузите сюда, затем используйте возвращённый full_size_url в вашем HTML. Используйте list_file_folders для выбора папки, list_files для просмотра существующих файлов и delete_file для удаления. Аргументы: name: Имя файла с расширением (например, 'hero.png'). Отображается в File Manager. file_data: Содержимое файла, закодированное в base64 (не URL и не сырые байты). folder_id: Необязательный ID папки (из list_file_folders), в которую загружать. Опустите для корневой папки. Возвращает: JSON с полями id (используйте как file_id), name, type, full_size_url (URL для встраивания), thumbnail_url, size, width, height, folder_id, created_at.

Параметры

  • namestringобязательный
  • file_datastringобязательный
  • folder_idany
  • accountany
upsert_memberидемпотентный

Добавляет участника в аудиторию или обновляет его, если он уже существует (идемпотентное добавление-или-обновление). Используйте, чтобы надёжно добавить или обновить участника за один вызов, без предварительной проверки существования. Используйте add_member, чтобы строго создать нового участника, или update_member, чтобы только изменить существующего. Аргументы: list_id: идентификатор аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. email_address: адрес электронной почты участника. Хеш подписчика вычисляется автоматически. status_if_new: статус, применяемый только при создании нового участника (по умолчанию 'subscribed'). Допустимые: 'subscribed', 'unsubscribed', 'cleaned', 'pending', 'transactional'. merge_fields: необязательный словарь значений полей слияния (например {'FNAME': 'Ada', 'LNAME': 'Lovelace'}). tags: необязательный список названий тегов для применения к участнику. Возвращает: JSON с id, email_address, status, merge_fields, tags, list_id и временными метками. Возвращает объект ошибки, если входные данные отвергнуты.

Добавляет участника в аудиторию или обновляет его, если он уже существует (идемпотентное добавление-или-обновление). Используйте, чтобы надёжно добавить или обновить участника за один вызов, без предварительной проверки существования. Используйте add_member, чтобы строго создать нового участника, или update_member, чтобы только изменить существующего. Аргументы: list_id: идентификатор аудитории/списка (10-символьный буквенно-цифровой, например 'abc123def4'). Получить из list_audiences. email_address: адрес электронной почты участника. Хеш подписчика вычисляется автоматически. status_if_new: статус, применяемый только при создании нового участника (по умолчанию 'subscribed'). Допустимые: 'subscribed', 'unsubscribed', 'cleaned', 'pending', 'transactional'. merge_fields: необязательный словарь значений полей слияния (например {'FNAME': 'Ada', 'LNAME': 'Lovelace'}). tags: необязательный список названий тегов для применения к участнику. Возвращает: JSON с id, email_address, status, merge_fields, tags, list_id и временными метками. Возвращает объект ошибки, если входные данные отвергнуты.

Параметры

  • list_idstringобязательный
  • email_addressstringобязательный
  • status_if_newstring
  • merge_fieldsany
  • tagsany
  • accountany
verify_connected_site_script

Проверьте, что скрипт отслеживания Mailchimp корректно установлен на подключенном сайте. Запускайте после установки скрипта, возвращенного create_connected_site, чтобы подтвердить, что Mailchimp может его обнаружить. Вместо этого используйте get_connected_site для проверки текущего статуса установки. Аргументы: connected_site_id: ID подключенного сайта для проверки. Получить из list_connected_sites. Возвращает: JSON с записью подключенного сайта, отражающей обновленный статус установки скрипта.

Проверьте, что скрипт отслеживания Mailchimp корректно установлен на подключенном сайте. Запускайте после установки скрипта, возвращенного create_connected_site, чтобы подтвердить, что Mailchimp может его обнаружить. Вместо этого используйте get_connected_site для проверки текущего статуса установки. Аргументы: connected_site_id: ID подключенного сайта для проверки. Получить из list_connected_sites. Возвращает: JSON с записью подключенного сайта, отражающей обновленный статус установки скрипта.

Параметры

  • connected_site_idstringобязательный
  • accountany
verify_verified_domain

Завершите проверку домена: отправьте код, полученный по email на адрес для верификации. Сначала выполните create_verified_domain, чтобы запустить отправку письма, затем передайте полученный код сюда. После верификации домен сможет проходить аутентификацию и использоваться как адрес отправителя. Args: domain_name: Проверяемый домен отправителя (например, 'mail.example.com'). Получите из list_verified_domains. code: Код верификации, отправленный на адрес из create_verified_domain. Returns: JSON с полями domain, verified (логическое), authenticated (логическое), verification_status, authentication_status.

Завершите проверку домена: отправьте код, полученный по email на адрес для верификации. Сначала выполните create_verified_domain, чтобы запустить отправку письма, затем передайте полученный код сюда. После верификации домен сможет проходить аутентификацию и использоваться как адрес отправителя. Args: domain_name: Проверяемый домен отправителя (например, 'mail.example.com'). Получите из list_verified_domains. code: Код верификации, отправленный на адрес из create_verified_domain. Returns: JSON с полями domain, verified (логическое), authenticated (логическое), verification_status, authentication_status.

Параметры

  • domain_namestringобязательный
  • codestringобязательный
  • accountany

Другие проверенные MCP-сервера

Vultr MCP

Vultr MCP

официальный

Сервер Vultr MCP позволяет AI-агентам управлять облачными ресурсами через естественный язык. Инструменты генерируются из OpenAPI, поддерживаются STDIO и HTTP, аутентификация по API ключу и OAuth. Подходит для DevOps.

Python1
QuackbackIO/quackback

QuackbackIO/quackback

официальный

MCP-сервер Quackback даёт AI-агентам 23 инструмента для поиска, сортировки и обработки отзывов. Сервер автоматизирует сбор, приоритизацию и закрытие цикла фидбека — интеграции с Slack, Jira и 20+ сервисами без vendor lock-in.

TypeScript181
shashankss1205/codegraphcontext

shashankss1205/codegraphcontext

CodeGraphContext — MCP-сервер для построения графа кода из репозитория. Он даёт AI-ассистентам и разработчикам искать зависимости, цепочки вызовов и мёртвый код через естественные запросы или CLI. ...

Python3957
mnemox-ai/tradememory-protocol

mnemox-ai/tradememory-protocol

официальный

MCP сервер, запоминающий каждую сделку с SHA-256 защитой. Анализируйте историю решений, выявляйте ошибки и соблюдайте нормы MiFID II и EU AI Act с помощью пре-флайт чеклистов и OWM.

Python1397
localstack/localstack-mcp-server

localstack/localstack-mcp-server

официальный

MCP-сервер для управления LocalStack — эмулятором облака. Разворачивайте стек (Terraform, CDK, SAM), анализируйте логи и инжектируйте сбои. Помогает разработчикам и DevOps быстрее отлаживать облачн...

TypeScript26
julien040/anyquery

julien040/anyquery

MCP сервер Anyquery дает возможность языковым моделям выполнять SQL-запросы к файлам, базам данных и приложениям. Полезен разработчикам и аналитикам, чтобы дать AI прямой доступ к данным через един...

Go1735
© Каталог MCP, 2026. Все права защищены.
Проект не аффилирован с Anthropic и любыми упомянутыми продуктами.
Все названия и торговые марки принадлежат их владельцам.
Контакты для связи: hi@mcp-katalog.ru

Лука Никитин