Mailchimp — мощная платформа маркетинговой автоматизации, которая позволяет управлять аудиториями, кампаниями и широким спектром маркетинговых активностей в одном месте. Мощный API и интеграции Mailchimp дают возможность автоматизировать рассылки, email-маркетинг, отчётность и работу с аудиториями прямо из ваших воркфлоу в AACFlow.
Инструменты Mailchimp в AACFlow позволяют:
-
Управление аудиториями (списками):
- Получайте список и подробную информацию обо всех аудиториях (списках) Mailchimp для удобного управления.
- Получайте полные сведения о конкретной аудитории.
- Создавайте новые аудитории и поддерживайте сегментацию в актуальном состоянии.
-
Участники списков:
- Получайте доступ и управляйте участниками списков (подписчиками), получайте подробную информацию о них и поддерживайте email-списки в синхронизированном виде.
-
Управление кампаниями:
- Автоматизируйте создание кампаний, отправляйте их и анализируйте эффективность с помощью развёрнутых отчётов.
-
Маркетинговая автоматизация:
- Управляйте автоматическими сценариями, настраивайте триггеры и планируйте рассылки, упрощая процессы прогрева аудитории.
-
Шаблоны, сегменты и теги:
- Получайте и управляйте email-шаблонами для единого фирменного стиля.
- Просматривайте и обновляйте сегменты аудиторий для точного таргетинга.
- Создавайте и управляйте тегами для удобной организации контактов.
-
Расширенное управление списками:
- Управляйте merge-полями и категориями интересов (группами), чтобы собирать богатые структурированные данные о подписчиках.
- Работайте с лендингами, формами подписки и другими инструментами захвата лидов для максимизации конверсий.
-
Пакетные операции и отчётность:
- Запускайте пакетные задачи для массовых операций и упрощайте крупные обновления.
- Получайте подробные отчёты по кампаниям, автоматизациям и росту аудитории, чтобы принимать решения на основе данных.
Используя Mailchimp в AACFlow, ваши AI-агенты и воркфлоу могут автоматизировать email-маркетинг в масштабе — наращивать аудиторию, персонализировать коммуникации, повышать вовлечённость и принимать решения на основе данных. Будь то синхронизация записей CRM, запуск кампаний в ответ на действия в продукте или управление данными подписчиков — инструменты Mailchimp в AACFlow дают полный программный контроль над маркетинговой автоматизацией.
Интегрируйте Mailchimp в рабочий процесс. Может управлять аудиториями (lists), list members, campaigns, automation workflows, templates, reports, segments, tags, merge fields, interest categories, landing pages, signup forms, и batch operations.
Получить список аудиторий (списков) из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
count | string | Нет | Количество результатов для возврата (default: 10, max: 1000) |
offset | string | Нет | Количество результатов для пропуска for постраничная выборка |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли audiences were successfully retrieved |
output | object | Audiences data |
↳ lists | json | Массив audience/list objects |
↳ total_items | number | Total number of lists |
↳ total_returned | number | Number of lists returned in this response |
Получить детали a specific audience (list) из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли audience was successfully retrieved |
output | object | Audience data |
↳ list | json | Audience/list object |
↳ list_id | string | The unique ID of the audience |
Создать новый audience (list) в Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
audienceName | string | Да | The name of аудитория/список (e.g., "Newsletter Subscribers") |
contact | string | Да | JSON object of contact information (e.g., {"company": "Acme", "address1": "123 Main St", "city": "NYC", "state": "NY", "zip": "10001", "country": "US"}) |
permissionReminder | string | Да | Permission reminder text shown to subscribers (e.g., "You signed up for updates on our website") |
campaignDefaults | string | Да | JSON object of default campaign settings (e.g., {"from_name": "Acme", "from_email": "news@acme.com", "subject": "", "language": "en"}) |
emailTypeOption | string | Да | Support multiple email formats: "true" or "false" |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Created audience data |
↳ list | json | Created audience/list object |
↳ list_id | string | Created audience/list ID |
↳ success | boolean | Operation success |
Обновитьn existing audience (list) в Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
audienceName | string | Нет | name of аудитория/список (e.g., "Newsletter Subscribers") |
permissionReminder | string | Нет | Permission reminder text shown to subscribers (e.g., "You signed up for updates on our website") |
campaignDefaults | string | Нет | JSON object of default campaign settings (e.g., {"from_name": "Acme", "from_email": "news@acme.com"}) |
emailTypeOption | string | Нет | Support multiple email formats: "true" or "false" |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Updated audience data |
↳ list | object | Updated audience/list object |
↳ list_id | string | List ID |
↳ success | boolean | Operation success |
Удалитьn audience (list) из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список to delete (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли audience was successfully deleted |
Получить список of members from a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
status | string | Нет | Filter by status: "subscribed", "unsubscribed", "cleaned", or "pending" |
count | string | Нет | Количество результатов для возврата (default: 10, max: 1000) |
offset | string | Нет | Количество результатов для пропуска for постраничная выборка |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли members were successfully retrieved |
output | object | Members data |
↳ members | json | Массив member objects |
↳ total_items | number | Total number of members |
↳ total_returned | number | Number of members returned in this response |
Получить детали a specific member from a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
subscriberEmail | string | Да | Member email address or MD5 hash of the lowercase email |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли member was successfully retrieved |
output | object | Member data |
↳ member | json | Member object |
↳ subscriber_hash | string | The MD5 hash of the member email address |
Добавить новый member to a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
emailAddress | string | Да | Member email address (e.g., "user@example.com") |
status | string | Да | Subscriber status: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional" |
mergeFields | string | Нет | JSON object of merge fields (e.g., {"FNAME": "John", "LNAME": "Doe"}) |
interests | string | Нет | JSON object of interest IDs and their boolean values (e.g., {"abc123": true}) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Added member data |
↳ member | json | Added member object |
↳ subscriber_hash | string | Subscriber hash ID |
↳ success | boolean | Operation success |
Добавить новый member или update an existing member in a Mailchimp audience (upsert)
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
subscriberEmail | string | Да | Member email address or MD5 hash of the lowercase email |
emailAddress | string | Да | Member email address (e.g., "user@example.com") |
statusIfNew | string | Да | Subscriber status if new: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional" |
mergeFields | string | Нет | JSON object of merge fields (e.g., {"FNAME": "John", "LNAME": "Doe"}) |
interests | string | Нет | JSON object of interest IDs and their boolean values (e.g., {"abc123": true}) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Member data |
↳ member | json | Member object |
↳ subscriber_hash | string | Subscriber hash ID |
↳ success | boolean | Operation success |
Обновитьn existing member in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
subscriberEmail | string | Да | Member email address or MD5 hash of the lowercase email |
emailAddress | string | Нет | New member email address (e.g., "user@example.com") |
status | string | Нет | Subscriber status: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional" |
mergeFields | string | Нет | JSON object of merge fields (e.g., {"FNAME": "John", "LNAME": "Doe"}) |
interests | string | Нет | JSON object of interest IDs and their boolean values (e.g., {"abc123": true}) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Updated member data |
↳ member | object | Updated member object |
↳ subscriber_hash | string | Subscriber hash |
↳ success | boolean | Operation success |
Удалить member from a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
subscriberEmail | string | Да | Member email address or MD5 hash of the lowercase email |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли member was successfully deleted |
Permanently archive (delete) a member from a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
subscriberEmail | string | Да | Member email address or MD5 hash of the lowercase email |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Archive confirmation |
↳ success | boolean | Operation success |
Restore an archived member to a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
subscriberEmail | string | Да | Member email address or MD5 hash of the lowercase email |
emailAddress | string | Да | Member email address (e.g., "user@example.com") |
status | string | Да | Subscriber status: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional" |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Unarchived member data |
↳ member | object | Unarchived member object |
↳ subscriber_hash | string | Subscriber hash |
↳ success | boolean | Operation success |
Получить список of campaigns из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
campaignType | string | Нет | Filter by campaign type: "regular", "plaintext", "absplit", "rss", or "variate" |
status | string | Нет | Filter by status: "save", "paused", "schedule", "sending", or "sent" |
count | string | Нет | Количество результатов для возврата (default: 10, max: 1000) |
offset | string | Нет | Количество результатов для пропуска for постраничная выборка |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли campaigns were successfully retrieved |
output | object | Campaigns data |
↳ campaigns | json | Массив campaign objects |
↳ total_items | number | Total number of campaigns |
↳ total_returned | number | Number of campaigns returned in this response |
Получить детали a specific campaign из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
campaignId | string | Да | Уникальный идентификатор для the campaign (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли campaign was successfully retrieved |
output | object | Campaign data |
↳ campaign | json | Campaign object |
↳ campaign_id | string | The unique ID of the campaign |
Создать новый campaign в Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
campaignType | string | Да | Campaign type: "regular", "plaintext", "absplit", "rss", or "variate" |
campaignSettings | string | Да | JSON object of campaign settings (e.g., {"subject_line": "Newsletter", "from_name": "Acme", "reply_to": "news@acme.com"}) |
recipients | string | Нет | JSON object of recipients (e.g., {"list_id": "abc123"}) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Created campaign data |
↳ campaign | json | Created campaign object |
↳ campaign_id | string | Created campaign ID |
↳ success | boolean | Operation success |
Обновитьn existing campaign в Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
campaignId | string | Да | Уникальный идентификатор для the campaign (e.g., "abc123def4") |
campaignSettings | string | Нет | JSON object of campaign settings (e.g., {"subject_line": "Newsletter", "from_name": "Acme"}) |
recipients | string | Нет | JSON object of recipients (e.g., {"list_id": "abc123"}) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Updated campaign data |
↳ campaign | object | Updated campaign object |
↳ campaign_id | string | Campaign ID |
↳ success | boolean | Operation success |
Удалить campaign из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
campaignId | string | Да | Уникальный идентификатор для the campaign to delete (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли campaign was successfully deleted |
Отправить a Mailchimp campaign
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
campaignId | string | Да | Уникальный идентификатор для the campaign to send (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Send confirmation |
↳ success | boolean | Operation success |
Запланировать кампанию Mailchimp на be sent at a specific time
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
campaignId | string | Да | Уникальный идентификатор для the campaign to schedule (e.g., "abc123def4") |
scheduleTime | string | Да | Schedule time in ISO 8601 format (e.g., "2024-12-25T10:00:00Z") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли campaign was successfully scheduled |
Unschedule a previously scheduled Mailchimp campaign
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
campaignId | string | Да | Уникальный идентификатор для the campaign to unschedule (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Unschedule confirmation |
↳ success | boolean | Operation success |
Создать a copy of an existing Mailchimp campaign
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
campaignId | string | Да | Уникальный идентификатор для the campaign to replicate (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Replicated campaign data |
↳ campaign | object | Replicated campaign object |
↳ campaign_id | string | Campaign ID |
↳ success | boolean | Operation success |
Получить HTML и plain-text content для a Mailchimp campaign
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
campaignId | string | Да | Уникальный идентификатор для the campaign (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли campaign content was successfully retrieved |
output | object | Campaign content data |
↳ content | json | Campaign content object |
Установить content для a Mailchimp campaign
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
campaignId | string | Да | Уникальный идентификатор для the campaign (e.g., "abc123def4") |
html | string | Нет | HTML content for the campaign |
plainText | string | Нет | plain-text content for the campaign |
templateId | string | Нет | unique ID of the template to use (e.g., "12345") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Campaign content data |
↳ content | object | Campaign content object |
↳ success | boolean | Operation success |
Получить список of automations из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
count | string | Нет | Количество результатов для возврата (default: 10, max: 1000) |
offset | string | Нет | Количество результатов для пропуска for постраничная выборка |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли automations were successfully retrieved |
output | object | Automations data |
↳ automations | json | Массив automation objects |
↳ total_items | number | Total number of automations |
↳ total_returned | number | Number of automations returned in this response |
Получить детали a specific automation из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
workflowId | string | Да | Уникальный идентификатор для the automation workflow (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли automation was successfully retrieved |
output | object | Automation data |
↳ automation | json | Automation object |
↳ workflow_id | string | The unique ID of the automation workflow |
Начатьll emails in a Mailchimp automation workflow
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
workflowId | string | Да | Уникальный идентификатор для the automation workflow (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Start confirmation |
↳ success | boolean | Operation success |
Приостановитьll emails in a Mailchimp automation workflow
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
workflowId | string | Да | Уникальный идентификатор для the automation workflow (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Pause confirmation |
↳ success | boolean | Operation success |
Manually add a subscriber to a workflow email queue
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
workflowId | string | Да | Уникальный идентификатор для the automation workflow (e.g., "abc123def4") |
workflowEmailId | string | Да | Уникальный идентификатор для the workflow email (e.g., "xyz789") |
emailAddress | string | Да | Email address of the subscriber (e.g., "user@example.com") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Subscriber queue data |
↳ subscriber | json | Subscriber object |
↳ success | boolean | Operation success |
Получить список of templates из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
count | string | Нет | Количество результатов для возврата (default: 10, max: 1000) |
offset | string | Нет | Количество результатов для пропуска for постраничная выборка |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли templates were successfully retrieved |
output | object | Templates data |
↳ templates | json | Массив template objects |
↳ total_items | number | Total number of templates |
↳ total_returned | number | Number of templates returned in this response |
Получить детали a specific template из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
templateId | string | Да | Уникальный идентификатор для the template (e.g., "12345") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли template was successfully retrieved |
output | object | Template data |
↳ template | json | Template object |
↳ template_id | string | The unique ID of the template |
Создать новый template в Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
templateName | string | Да | The name of the template (e.g., "Monthly Newsletter") |
templateHtml | string | Да | The HTML content for the template |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Created template data |
↳ template | json | Created template object |
↳ template_id | string | Created template ID |
↳ success | boolean | Operation success |
Обновитьn existing template в Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
templateId | string | Да | Уникальный идентификатор для the template (e.g., "12345") |
templateName | string | Нет | name of the template (e.g., "Monthly Newsletter") |
templateHtml | string | Нет | HTML content for the template |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Updated template data |
↳ template | object | Updated template object |
↳ template_id | string | Template ID |
↳ success | boolean | Operation success |
Удалить template из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
templateId | string | Да | Уникальный идентификатор для the template to delete (e.g., "12345") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли template was successfully deleted |
Получить список of campaign reports из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
count | string | Нет | Количество результатов для возврата (default: 10, max: 1000) |
offset | string | Нет | Количество результатов для пропуска for постраничная выборка |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли campaign reports were successfully retrieved |
output | object | Campaign reports data |
↳ reports | json | Массив campaign report objects |
↳ total_items | number | Total number of reports |
↳ total_returned | number | Number of reports returned in this response |
Получить report для a specific campaign из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
campaignId | string | Да | Уникальный идентификатор для the campaign (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли campaign report was successfully retrieved |
output | object | Campaign report data |
↳ report | json | Campaign report object |
↳ campaign_id | string | The unique ID of the campaign |
Получить список of segments from a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
count | string | Нет | Количество результатов для возврата (default: 10, max: 1000) |
offset | string | Нет | Количество результатов для пропуска for постраничная выборка |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли segments were successfully retrieved |
output | object | Segments data |
↳ segments | json | Массив segment objects |
↳ total_items | number | Total number of segments |
↳ total_returned | number | Number of segments returned in this response |
Получить детали a specific segment from a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
segmentId | string | Да | Уникальный идентификатор для the segment (e.g., "12345") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли segment was successfully retrieved |
output | object | Segment data |
↳ segment | json | Segment object |
↳ segment_id | string | The unique ID of the segment |
Создать новый segment in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
segmentName | string | Да | The name of the segment (e.g., "VIP Customers") |
segmentOptions | string | Нет | JSON object of segment options for saved segments (e.g., {"match": "all", "conditions": [...]}) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Created segment data |
↳ segment | json | Created segment object |
↳ segment_id | string | Created segment ID |
↳ success | boolean | Operation success |
Обновитьn existing segment in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
segmentId | string | Да | Уникальный идентификатор для the segment (e.g., "12345") |
segmentName | string | Нет | name of the segment (e.g., "VIP Customers") |
segmentOptions | string | Нет | JSON object of segment options (e.g., {"match": "all", "conditions": [...]}) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Updated segment data |
↳ segment | object | Updated segment object |
↳ segment_id | string | Segment ID |
↳ success | boolean | Operation success |
Удалить segment from a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
segmentId | string | Да | Уникальный идентификатор для the segment to delete (e.g., "12345") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли segment was successfully deleted |
Получить members of a specific segment from a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
segmentId | string | Да | Уникальный идентификатор для the segment (e.g., "12345") |
count | string | Нет | Количество результатов для возврата (default: 10, max: 1000) |
offset | string | Нет | Количество результатов для пропуска for постраничная выборка |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли segment members were successfully retrieved |
output | object | Segment members data |
↳ members | json | Массив member objects |
↳ total_items | number | Total number of members |
↳ total_returned | number | Number of members returned in this response |
Добавить участника to a specific segment in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
segmentId | string | Да | Уникальный идентификатор для the segment (e.g., "12345") |
emailAddress | string | Да | Email address of the member (e.g., "user@example.com") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Added member data |
↳ member | json | Added member object |
↳ success | boolean | Operation success |
Remove a member from a specific segment in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
segmentId | string | Да | Уникальный идентификатор для the segment (e.g., "12345") |
subscriberEmail | string | Да | Member email address or MD5 hash of the lowercase email |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Removal confirmation |
↳ success | boolean | Operation success |
Получить tags associated с a member in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
subscriberEmail | string | Да | Member email address or MD5 hash of the lowercase email |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли member tags were successfully retrieved |
output | object | Member tags data |
↳ tags | json | Массив tag objects |
↳ total_items | number | Total number of tags |
↳ total_returned | number | Number of tags returned in this response |
Добавить tags to a member in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
subscriberEmail | string | Да | Member email address or MD5 hash of the lowercase email |
tags | string | Да | JSON array of tag objects (e.g., [{"name": "VIP", "status": "active"}]) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Tag addition confirmation |
↳ success | boolean | Operation success |
Remove tags from a member in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
subscriberEmail | string | Да | Member email address or MD5 hash of the lowercase email |
tags | string | Да | JSON array of tag objects with inactive status (e.g., [{"name": "VIP", "status": "inactive"}]) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Tag removal confirmation |
↳ success | boolean | Operation success |
Получить список of merge fields from a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
count | string | Нет | Количество результатов для возврата (default: 10, max: 1000) |
offset | string | Нет | Количество результатов для пропуска for постраничная выборка |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли merge fields were successfully retrieved |
output | object | Merge fields data |
↳ mergeFields | json | Массив merge field objects |
↳ total_items | number | Total number of merge fields |
↳ total_returned | number | Number of merge fields returned in this response |
Получить детали a specific merge field from a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
mergeId | string | Да | Уникальный идентификатор для the merge field (e.g., "1" or "FNAME") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли merge field was successfully retrieved |
output | object | Merge field data |
↳ mergeField | json | Merge field object |
↳ merge_id | string | The unique ID of the merge field |
Создать новый merge field in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
mergeName | string | Да | The name of the merge field (e.g., "First Name") |
mergeType | string | Да | The type of the merge field: "text", "number", "address", "phone", "date", "url", "imageurl", "radio", "dropdown", "birthday", or "zip" |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Created merge field data |
↳ mergeField | json | Created merge field object |
↳ merge_id | string | Created merge field ID |
↳ success | boolean | Operation success |
Обновитьn existing merge field in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
mergeId | string | Да | Уникальный идентификатор для the merge field (e.g., "1" or "FNAME") |
mergeName | string | Нет | name of the merge field (e.g., "First Name") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Updated merge field data |
↳ mergeField | object | Updated merge field object |
↳ merge_id | string | Merge field ID |
↳ success | boolean | Operation success |
Удалить merge field from a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
mergeId | string | Да | Уникальный идентификатор для the merge field to delete (e.g., "1" or "FNAME") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли merge field was successfully deleted |
Получить список of interest categories from a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
count | string | Нет | Количество результатов для возврата (default: 10, max: 1000) |
offset | string | Нет | Количество результатов для пропуска for постраничная выборка |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли interest categories were successfully retrieved |
output | object | Interest categories data |
↳ categories | json | Массив interest category objects |
↳ total_items | number | Total number of categories |
↳ total_returned | number | Number of categories returned in this response |
Получить детали a specific interest category from a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
interestCategoryId | string | Да | Уникальный идентификатор для the interest category (e.g., "xyz789") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли interest category was successfully retrieved |
output | object | Interest category data |
↳ category | json | Interest category object |
↳ interest_category_id | string | The unique ID of the interest category |
Создать новый interest category in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
interestCategoryTitle | string | Да | The title of the interest category (e.g., "Email Preferences") |
interestCategoryType | string | Да | The type of interest category: "checkboxes", "dropdown", "radio", or "hidden" |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Created interest category data |
↳ category | json | Created interest category object |
↳ interest_category_id | string | Created interest category ID |
↳ success | boolean | Operation success |
Обновитьn existing interest category in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
interestCategoryId | string | Да | Уникальный идентификатор для the interest category (e.g., "xyz789") |
interestCategoryTitle | string | Нет | title of the interest category (e.g., "Email Preferences") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Updated interest category data |
↳ category | object | Updated interest category object |
↳ interest_category_id | string | Interest category ID |
↳ success | boolean | Operation success |
Удалитьn interest category from a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
interestCategoryId | string | Да | Уникальный идентификатор для the interest category to delete (e.g., "xyz789") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли interest category was successfully deleted |
Получить список of interests from an interest category in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
interestCategoryId | string | Да | Уникальный идентификатор для the interest category (e.g., "xyz789") |
count | string | Нет | Количество результатов для возврата (default: 10, max: 1000) |
offset | string | Нет | Количество результатов для пропуска for постраничная выборка |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли interests were successfully retrieved |
output | object | Interests data |
↳ interests | json | Массив interest objects |
↳ total_items | number | Total number of interests |
↳ total_returned | number | Number of interests returned in this response |
Получить детали a specific interest from an interest category in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
interestCategoryId | string | Да | Уникальный идентификатор для the interest category (e.g., "xyz789") |
interestId | string | Да | Уникальный идентификатор для the interest (e.g., "def456") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли interest was successfully retrieved |
output | object | Interest data |
↳ interest | json | Interest object |
↳ interest_id | string | The unique ID of the interest |
Создать новый interest in an interest category in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
interestCategoryId | string | Да | Уникальный идентификатор для the interest category (e.g., "xyz789") |
interestName | string | Да | The name of the interest (e.g., "Weekly Updates") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Created interest data |
↳ interest | json | Created interest object |
↳ interest_id | string | Created interest ID |
↳ success | boolean | Operation success |
Обновитьn existing interest in an interest category in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
interestCategoryId | string | Да | Уникальный идентификатор для the interest category (e.g., "xyz789") |
interestId | string | Да | Уникальный идентификатор для the interest (e.g., "def456") |
interestName | string | Нет | name of the interest (e.g., "Weekly Updates") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Updated interest data |
↳ interest | object | Updated interest object |
↳ interest_id | string | Interest ID |
↳ success | boolean | Operation success |
Удалитьn interest from an interest category in a Mailchimp audience
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
listId | string | Да | Уникальный идентификатор для аудитория/список (e.g., "abc123def4") |
interestCategoryId | string | Да | Уникальный идентификатор для the interest category (e.g., "xyz789") |
interestId | string | Да | Уникальный идентификатор для the interest to delete (e.g., "def456") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли interest was successfully deleted |
Получить список of landing pages из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
count | string | Нет | Количество результатов для возврата (default: 10, max: 1000) |
offset | string | Нет | Количество результатов для пропуска for постраничная выборка |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли landing pages were successfully retrieved |
output | object | Landing pages data |
↳ landingPages | json | Массив landing page objects |
↳ total_items | number | Total number of landing pages |
↳ total_returned | number | Number of landing pages returned in this response |
Получить детали a specific landing page из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
pageId | string | Да | Уникальный идентификатор для the landing page (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли landing page was successfully retrieved |
output | object | Landing page data |
↳ landingPage | json | Landing page object |
↳ page_id | string | The unique ID of the landing page |
Создать новый landing page в Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
landingPageType | string | Да | The type of landing page: "signup" |
landingPageTitle | string | Нет | title of the landing page (e.g., "Join Our Newsletter") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Created landing page data |
↳ landingPage | json | Created landing page object |
↳ page_id | string | Created landing page ID |
↳ success | boolean | Operation success |
Обновитьn existing landing page в Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
pageId | string | Да | Уникальный идентификатор для the landing page (e.g., "abc123def4") |
landingPageTitle | string | Нет | title of the landing page (e.g., "Join Our Newsletter") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Updated landing page data |
↳ landingPage | object | Updated landing page object |
↳ page_id | string | Landing page ID |
↳ success | boolean | Operation success |
Удалить landing page из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
pageId | string | Да | Уникальный идентификатор для the landing page to delete (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли landing page was successfully deleted |
Publish a landing page в Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
pageId | string | Да | Уникальный идентификатор для the landing page (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Publish confirmation |
↳ success | boolean | Operation success |
Unpublish a landing page в Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
pageId | string | Да | Уникальный идентификатор для the landing page (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Unpublish confirmation |
↳ success | boolean | Operation success |
Получить список of batch operations из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
count | string | Нет | Количество результатов для возврата (default: 10, max: 1000) |
offset | string | Нет | Количество результатов для пропуска for постраничная выборка |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли batch operations were successfully retrieved |
output | object | Batch operations data |
↳ batches | json | Массив batch operation objects |
↳ total_items | number | Total number of batch operations |
↳ total_returned | number | Number of batch operations returned in this response |
Получить детали a specific batch operation из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
batchId | string | Да | Уникальный идентификатор для the batch operation (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли batch operation was successfully retrieved |
output | object | Batch operation data |
↳ batch | json | Batch operation object |
↳ batch_id | string | The unique ID of the batch operation |
Создать новый batch operation в Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
operations | string | Да | JSON array of batch operations (e.g., [{"method": "POST", "path": "/lists/{list_id}/members", "body": "..."}]) |
| Параметр | Тип | Описание |
|---|
success | boolean | Operation success status |
output | object | Created batch operation data |
↳ batch | json | Created batch operation object |
↳ batch_id | string | Created batch operation ID |
↳ success | boolean | Operation success |
Удалить batch operation из Mailchimp
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Mailchimp API ключ с префиксом сервера |
batchId | string | Да | Уникальный идентификатор для the batch operation to delete (e.g., "abc123def4") |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли batch operation was successfully deleted |
