MailChimp
MailChimp — это служба SaaS, которая позволяет предприятиям управлять и автоматизировать маркетинговые действия электронной почты, включая отправку маркетинговых сообщений, автоматизированных сообщений и целевых кампаний.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Microsoft |
| URL |
Поддержка Microsoft LogicApps Поддержка Microsoft Power Automate Поддержка Microsoft Power Apps |
| Метаданные соединителя | |
|---|---|
| Publisher | Microsoft |
| Website | https://mailchimp.com/ |
| Политика конфиденциальности | https://mailchimp.com/legal/privacy/ |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Добавление участника в список |
Добавление или обновление элемента списка |
| Новая кампания (версия 2) |
Создайте новую кампанию на основе типа кампании, списка получателей и параметров кампании (тема, название, from_name и reply_to) (версия 2). |
| Новая кампания [не рекомендуется] |
Это действие устарело. Вместо этого используйте новую кампанию (V2 ).
|
| Новый список |
Создание списка в учетной записи MailChimp |
| Обновление сведений о членах |
Обновите сведения для определенного члена списка. |
| Отображение элементов списка |
Отображение всех элементов списка |
| Отправка кампании (предварительная версия) |
Отправка существующей кампании |
| Подписка или отмена подписки участников списка |
Пакетная подписка или отмена подписки участников списка. |
| Получение всех списков |
Поиск всех списков для текущего пользователя |
| Список кампаний |
Эта операция извлекает список кампаний в учетной записи |
| Удаление участника из списка |
Удаление элемента из списка. |
Добавление участника в список
Добавление или обновление элемента списка
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор списка
|
list_id | True | string |
Уникальный идентификатор списка |
|
Тип электронной почты
|
email_type | string |
Тип сообщения электронной почты, который попросил получить (html или text) |
|
|
Состояние
|
status | True | string |
Текущее состояние подписчика. Возможные значения: подписка, отмена подписки, очистка, ожидание |
|
Имя (Первое имя)
|
FNAME | string |
Имя подписчика |
|
|
Фамилия
|
LNAME | string |
Фамилия подписчика |
|
|
Language
|
language | string |
Если задано или обнаружено, язык подписчика |
|
|
ВИП
|
vip | boolean |
Состояние ВИРТУАЛЬНОГО IP-адреса для подписчика |
|
|
Широта
|
latitude | float |
Широта расположения |
|
|
Долгота
|
longitude | float |
Расположение долготы |
|
|
Электронная почта
|
email_address | True | string |
Адрес электронной почты для подписчика |
Возвращаемое значение
Модель результатов члена
- Тело
- MemberResponseModel
Новая кампания (версия 2)
Создайте новую кампанию на основе типа кампании, списка получателей и параметров кампании (тема, название, from_name и reply_to) (версия 2).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип кампании
|
type | True | string |
Существует четыре типа кампаний, которые можно создать в MailChimp. Вместо этого следует использовать нерекомендуемые кампании A/B Split и вариативные кампании. Возможные значения: обычный, открытый текст, absplit, rss, variate |
|
Идентификатор списка
|
list_id | True | string |
Уникальный идентификатор списка |
|
Сохраненный идентификатор сегмента
|
saved_segment_id | integer |
Идентификатор существующего сохраненного сегмента |
|
|
Тип совпадения
|
match | string |
Тип сопоставления сегментов: возможные значения: любые, все |
|
|
Строка темы кампании
|
subject_line | True | string |
Тема кампании |
|
Название
|
title | string |
Название кампании |
|
|
Имя
|
from_name | True | string |
Имя from в кампании (а не адрес электронной почты) |
|
Ответ на адрес
|
reply_to | True | string |
Адрес электронной почты для кампании |
|
Беседа
|
use_conversation | boolean |
Использование функции беседы MailChimp для управления ответами вне офиса |
|
|
Имя
|
to_name | string |
Имя кампании "To". Обычно поле слияния имени |
|
|
Идентификатор папки
|
folder_id | string |
Если кампания указана в папке, идентификатор этой папки |
|
|
Authentication
|
authenticate | boolean |
Проверка подлинности кампании в MailChimp. Значение по умолчанию имеет значение true |
|
|
Автоматический нижний колонтитул
|
auto_footer | boolean |
Автоматическое добавление нижнего колонтитула MailChimp по умолчанию в кампанию |
|
|
Встроенный CSS
|
inline_css | boolean |
Автоматически встраивайте CSS, включенные в содержимое кампании |
|
|
Автоматическое твита
|
auto_tweet | boolean |
Автоматически твит ссылки на страницу архива кампании при отправке кампании |
|
|
Автозапуск в Facebook
|
auto_fb_post | array of integer |
Массив идентификаторов страницы Facebook для автоматической публикации |
|
|
Комментарии в Facebook
|
fb_comments | boolean |
Разрешает комментарии Facebook по кампании (также принудительно включает панель инструментов архива кампании). Значение по умолчанию имеет значение true |
|
|
Критерии победы
|
winner_criteria | string |
Сочетание, которое выполняет лучшие. Это может быть определено автоматически по частоте щелчков, открытой ставке или общему доходу, или вы можете выбрать вручную на основе данных отчета, которые вы найдете наиболее ценными. Для многовариантных кампаний тестирования send_time winner_critera игнорируется. Для многовариантных кампаний с "вручную" в качестве winner_citeria победитель должен быть выбран в веб-приложении MailChimp |
|
|
Время ожидания
|
wait_time | integer |
Количество минут, которые нужно ждать, прежде чем выбрать победную кампанию. Значение wait_time должно быть больше 0 и в целых часах, указанных в минутах. |
|
|
Размер теста
|
test_size | integer |
Процент получателей для отправки сочетаний тестов должен быть значением от 10 до 100 |
|
|
Строки темы
|
subject_lines | array of string |
Возможные строки субъектов для тестирования. Если строки темы не указаны, settings.subject_line будет использоваться |
|
|
Время отправки
|
send_times | array of string |
Возможное время отправки для тестирования. Время должно быть в формате ГГГГ-MM-DD HH:MM:SS. Если send_times предоставляются для тестирования, test_size будет задано значение 100% и winner_criteria будет игнорироваться. |
|
|
Из имен
|
from_names | array of string |
Возможные из имен. Число предоставленных from_names должно соответствовать количеству reply_to_addresses. Если from_names не задано, settings.from_name будет использоваться |
|
|
Ответ на адреса
|
reply_to_addresses | array of string |
Возможные из имен. Число предоставленных from_names должно соответствовать количеству reply_to_addresses. Если from_names не задано, settings.from_name будет использоваться |
|
|
Открытия
|
opens | boolean |
Открывается ли отслеживание. По умолчанию используется значение true. Невозможно задать значение false для вариативных кампаний |
|
|
Отслеживание нажатия html
|
html_clicks | boolean |
Следует ли отслеживать щелчки в HTML-версии кампании. По умолчанию используется значение true. Невозможно задать значение false для вариативных кампаний |
|
|
Plain-Text отслеживание щелчка
|
text_clicks | boolean |
Следует ли отслеживать щелчки в обычной текстовой версии кампании. По умолчанию используется значение true. Невозможно задать значение false для вариативных кампаний |
|
|
Отслеживание целей MailChimp
|
goal_tracking | boolean |
Включение отслеживания целей |
|
|
Отслеживание e Commerce360
|
ecomm360 | boolean |
Включение отслеживания e Commerce360 |
|
|
Отслеживание Google Analytics
|
google_analytics | string |
Пользовательский slug для отслеживания Google Analytics (максимум 50 байт) |
|
|
Отслеживание аналитики ClickTale
|
clicktale | string |
Пользовательский slug для отслеживания ClickTale (максимум 50 байт) |
|
|
Кампания Salesforce
|
campaign | boolean |
Создание кампании в подключенной учетной записи Salesforce |
|
|
Заметка Salesforce
|
notes | boolean |
Обновление заметок контактов для кампании на основе адресов электронной почты подписчика |
|
|
Кампания Highrise
|
campaign | boolean |
Создание кампании в подключенной учетной записи Highrise |
|
|
Примечание Highrise
|
notes | boolean |
Обновление заметок контактов для кампании на основе адресов электронной почты подписчика |
|
|
Заметка о капсуле
|
notes | boolean |
Обновление заметок контактов для кампании на основе адресов электронной почты подписчика |
|
|
URL-адрес канала
|
feed_url | string |
URL-адрес веб-канала RSS |
|
|
Частота
|
frequency | string |
Частота кампании RSS |
|
|
Ограничение RSS-образов
|
constrain_rss_img | string |
Добавление CSS в образы в RSS-канале для ограничения их ширины в кампаниях |
|
|
Отправка часа
|
hour | integer |
Час отправки кампании в местное время. Допустимые часы — 0–23. Например, "4" будет 4 утра в часовом поясе вашей учетной записи по умолчанию |
|
|
Воскресенье
|
sunday | boolean |
Отправляет ежедневную кампанию RSS в воскресенье |
|
|
Monday
|
monday | boolean |
Отправляет ежедневную кампанию RSS в понедельник |
|
|
Вторник
|
tuesday | boolean |
Отправляет ежедневную кампанию RSS во вторник |
|
|
Среда
|
wednesday | boolean |
Отправляет ежедневную кампанию RSS в среду |
|
|
Четверг
|
thursday | boolean |
Отправляет ежедневную кампанию RSS в четверг |
|
|
Пятница
|
friday | boolean |
Отправляет ежедневную кампанию RSS в пятницу |
|
|
Суббота
|
saturday | boolean |
Отправляет ежедневную кампанию RSS в субботу |
|
|
Еженедельный день отправки
|
weekly_send_day | string |
День недели для отправки еженедельной кампании RSS |
|
|
День ежемесячной отправки
|
monthly_send_date | float |
День месяца для отправки ежемесячной кампании RSS. Допустимые дни 1-32, где "0" всегда является последним днем месяца. Месяцы с меньшим числом дней не будут отправляться в rsS-кампанию. Например, RSS-кампании, которые будут отправляться 30-й, не будут выходить в феврале |
|
|
URL-адрес изображения
|
image_url | string |
URL-адрес изображения заголовка карточки |
|
|
Описание кампании
|
description | string |
Краткая сводка кампании для отображения |
|
|
Название
|
title | string |
Заголовок карточки. Обычно тема кампании |
Возвращаемое значение
Новая модель результатов кампании
Новая кампания [не рекомендуется]
Это действие устарело. Вместо этого используйте новую кампанию (V2 ).
Создание новой кампании на основе типа кампании, списка получателей и параметров кампании (тема, название, from_name и reply_to)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип кампании
|
type | True | string |
Существует четыре типа кампаний, которые можно создать в MailChimp. Вместо этого следует использовать нерекомендуемые кампании A/B Split и вариативные кампании. Возможные значения: обычный, открытый текст, absplit, rss, variate |
|
Идентификатор списка
|
list_id | True | string |
Уникальный идентификатор списка |
|
Сохраненный идентификатор сегмента
|
saved_segment_id | integer |
Идентификатор существующего сохраненного сегмента |
|
|
Тип совпадения
|
match | string |
Тип сопоставления сегментов: возможные значения: любые, все |
|
|
Строка темы кампании
|
subject_line | True | string |
Тема кампании |
|
Название
|
title | string |
Название кампании |
|
|
Имя
|
from_name | True | string |
Имя from в кампании (а не адрес электронной почты) |
|
Ответ на адрес
|
reply_to | True | string |
Адрес электронной почты для кампании |
|
Беседа
|
use_conversation | boolean |
Использование функции беседы MailChimp для управления ответами вне офиса |
|
|
Имя
|
to_name | string |
Имя кампании "To". Обычно поле слияния имени |
|
|
Идентификатор папки
|
folder_id | integer |
Если кампания указана в папке, идентификатор этой папки |
|
|
Authentication
|
authenticate | boolean |
Проверка подлинности кампании в MailChimp. Значение по умолчанию имеет значение true |
|
|
Автоматический нижний колонтитул
|
auto_footer | boolean |
Автоматическое добавление нижнего колонтитула MailChimp по умолчанию в кампанию |
|
|
Встроенный CSS
|
inline_css | boolean |
Автоматически встраивайте CSS, включенные в содержимое кампании |
|
|
Автоматическое твита
|
auto_tweet | boolean |
Автоматически твит ссылки на страницу архива кампании при отправке кампании |
|
|
Автозапуск в Facebook
|
auto_fb_post | array of integer |
Массив идентификаторов страницы Facebook для автоматической публикации |
|
|
Комментарии в Facebook
|
fb_comments | boolean |
Разрешает комментарии Facebook по кампании (также принудительно включает панель инструментов архива кампании). Значение по умолчанию имеет значение true |
|
|
Критерии победы
|
winner_criteria | string |
Сочетание, которое выполняет лучшие. Это может быть определено автоматически по частоте щелчков, открытой ставке или общему доходу, или вы можете выбрать вручную на основе данных отчета, которые вы найдете наиболее ценными. Для многовариантных кампаний тестирования send_time winner_critera игнорируется. Для многовариантных кампаний с "вручную" в качестве winner_citeria победитель должен быть выбран в веб-приложении MailChimp |
|
|
Время ожидания
|
wait_time | integer |
Количество минут, которые нужно ждать, прежде чем выбрать победную кампанию. Значение wait_time должно быть больше 0 и в целых часах, указанных в минутах. |
|
|
Размер теста
|
test_size | integer |
Процент получателей для отправки сочетаний тестов должен быть значением от 10 до 100 |
|
|
Строки темы
|
subject_lines | array of string |
Возможные строки субъектов для тестирования. Если строки темы не указаны, settings.subject_line будет использоваться |
|
|
Время отправки
|
send_times | array of string |
Возможное время отправки для тестирования. Время должно быть в формате ГГГГ-MM-DD HH:MM:SS. Если send_times предоставляются для тестирования, test_size будет задано значение 100% и winner_criteria будет игнорироваться. |
|
|
Из имен
|
from_names | array of string |
Возможные из имен. Число предоставленных from_names должно соответствовать количеству reply_to_addresses. Если from_names не задано, settings.from_name будет использоваться |
|
|
Ответ на адреса
|
reply_to_addresses | array of string |
Возможные из имен. Число предоставленных from_names должно соответствовать количеству reply_to_addresses. Если from_names не задано, settings.from_name будет использоваться |
|
|
Открытия
|
opens | boolean |
Открывается ли отслеживание. По умолчанию используется значение true. Невозможно задать значение false для вариативных кампаний |
|
|
Отслеживание нажатия html
|
html_clicks | boolean |
Следует ли отслеживать щелчки в HTML-версии кампании. По умолчанию используется значение true. Невозможно задать значение false для вариативных кампаний |
|
|
Plain-Text отслеживание щелчка
|
text_clicks | boolean |
Следует ли отслеживать щелчки в обычной текстовой версии кампании. По умолчанию используется значение true. Невозможно задать значение false для вариативных кампаний |
|
|
Отслеживание целей MailChimp
|
goal_tracking | boolean |
Включение отслеживания целей |
|
|
Отслеживание e Commerce360
|
ecomm360 | boolean |
Включение отслеживания e Commerce360 |
|
|
Отслеживание Google Analytics
|
google_analytics | string |
Пользовательский slug для отслеживания Google Analytics (максимум 50 байт) |
|
|
Отслеживание аналитики ClickTale
|
clicktale | string |
Пользовательский slug для отслеживания ClickTale (максимум 50 байт) |
|
|
Кампания Salesforce
|
campaign | boolean |
Создание кампании в подключенной учетной записи Salesforce |
|
|
Заметка Salesforce
|
notes | boolean |
Обновление заметок контактов для кампании на основе адресов электронной почты подписчика |
|
|
Кампания Highrise
|
campaign | boolean |
Создание кампании в подключенной учетной записи Highrise |
|
|
Примечание Highrise
|
notes | boolean |
Обновление заметок контактов для кампании на основе адресов электронной почты подписчика |
|
|
Заметка о капсуле
|
notes | boolean |
Обновление заметок контактов для кампании на основе адресов электронной почты подписчика |
|
|
URL-адрес канала
|
feed_url | string |
URL-адрес веб-канала RSS |
|
|
Частота
|
frequency | string |
Частота кампании RSS |
|
|
Ограничение RSS-образов
|
constrain_rss_img | string |
Добавление CSS в образы в RSS-канале для ограничения их ширины в кампаниях |
|
|
Отправка часа
|
hour | integer |
Час отправки кампании в местное время. Допустимые часы — 0–23. Например, "4" будет 4 утра в часовом поясе вашей учетной записи по умолчанию |
|
|
Воскресенье
|
sunday | boolean |
Отправляет ежедневную кампанию RSS в воскресенье |
|
|
Monday
|
monday | boolean |
Отправляет ежедневную кампанию RSS в понедельник |
|
|
Вторник
|
tuesday | boolean |
Отправляет ежедневную кампанию RSS во вторник |
|
|
Среда
|
wednesday | boolean |
Отправляет ежедневную кампанию RSS в среду |
|
|
Четверг
|
thursday | boolean |
Отправляет ежедневную кампанию RSS в четверг |
|
|
Пятница
|
friday | boolean |
Отправляет ежедневную кампанию RSS в пятницу |
|
|
Суббота
|
saturday | boolean |
Отправляет ежедневную кампанию RSS в субботу |
|
|
Еженедельный день отправки
|
weekly_send_day | string |
День недели для отправки еженедельной кампании RSS |
|
|
День ежемесячной отправки
|
monthly_send_date | float |
День месяца для отправки ежемесячной кампании RSS. Допустимые дни 1-32, где "0" всегда является последним днем месяца. Месяцы с меньшим числом дней не будут отправляться в rsS-кампанию. Например, RSS-кампании, которые будут отправляться 30-й, не будут выходить в феврале |
|
|
URL-адрес изображения
|
image_url | string |
URL-адрес изображения заголовка карточки |
|
|
Описание кампании
|
description | string |
Краткая сводка кампании для отображения |
|
|
Название
|
title | string |
Заголовок карточки. Обычно тема кампании |
Возвращаемое значение
Новая модель результатов кампании
Новый список
Создание списка в учетной записи MailChimp
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя списка
|
name | True | string |
Имя списка |
|
Название компании
|
company | True | string |
Имя компании для списка |
|
Адресная строка 1
|
address1 | True | string |
Адрес улицы для контакта списка |
|
Строка адреса 2
|
address2 | string |
Адрес улицы для контакта списка |
|
|
Город
|
city | True | string |
Город для контакта со списком |
|
Государство
|
state | True | string |
Состояние контакта списка |
|
Почтовый индекс
|
zip | True | string |
Почтовый или почтовый индекс для контакта списка |
|
Код страны
|
country | True | string |
Код страны с двумя символами ISO3166. Значение по умолчанию для США, если недопустимо |
|
Номер телефона
|
phone | True | string |
Номер телефона для контакта списка |
|
Напоминание о разрешениях
|
permission_reminder | True | string |
Текст для напоминать людям о том, как они зарегистрировались в этом списке |
|
Использование архивной панели
|
use_archive_bar | boolean |
Используется ли кампания для этого списка архивной строкой в архивах по умолчанию |
|
|
Имя отправителя
|
from_name | True | string |
Значение по умолчанию для кампаний, отправленных в этот список |
|
Адрес электронной почты отправителя
|
from_email | True | string |
Значение по умолчанию из электронной почты для кампаний, отправленных в этот список |
|
Тема
|
subject | True | string |
Строка темы по умолчанию для кампаний, отправленных в этот список |
|
Language
|
language | True | string |
Язык по умолчанию для форм этих списков |
|
Уведомление о подписке
|
notify_on_subscribe | string |
Адрес электронной почты для отправки уведомлений о подписке на |
|
|
Уведомление об отмене подписки
|
notify_on_unsubscribe | string |
Адрес электронной почты для отправки уведомлений об отмене подписки |
|
|
Разрешить пользователям выбирать html-код и обычный текст (true/false)?
|
email_type_option | True | boolean |
Если задано значение true, подписчики могут выбрать, хотите ли они получать HTML или текстовые сообщения электронной почты. Если задано значение false, подписчики получат HTML-сообщения электронной почты с альтернативным резервным копированием обычного текста. |
|
Видимость
|
visibility | string |
Является ли этот список общедоступным или частным |
Возвращаемое значение
Создание модели результатов списка
Обновление сведений о членах
Обновите сведения для определенного члена списка.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор списка
|
list_id | True | string |
Уникальный идентификатор списка |
|
Электронная почта участника
|
member_email | True | string |
Уникальный адрес электронной почты участника для обновления |
|
Тип электронной почты
|
email_type | string |
Тип сообщения электронной почты, который попросил получить (html или text) |
|
|
Состояние
|
status | True | string |
Текущее состояние подписчика. Возможные значения: подписка, отмена подписки, очистка, ожидание |
|
Имя (Первое имя)
|
FNAME | string |
Имя подписчика |
|
|
Фамилия
|
LNAME | string |
Фамилия подписчика |
|
|
Language
|
language | string |
Если задано или обнаружено, язык подписчика |
|
|
ВИП
|
vip | boolean |
Состояние ВИРТУАЛЬНОГО IP-адреса для подписчика |
|
|
Широта
|
latitude | float |
Широта расположения |
|
|
Долгота
|
longitude | float |
Расположение долготы |
Возвращаемое значение
Модель результатов члена
- Тело
- MemberResponseModel
Отображение элементов списка
Отображение всех элементов списка
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор списка
|
list_id | True | string |
Уникальный идентификатор списка |
|
Максимальные результаты
|
count | integer |
Количество возвращаемых записей. Значение по умолчанию — 10. Максимальное значение равно 1000 |
|
|
Смещение
|
offset | integer |
Количество записей из коллекции для пропуска. Значение по умолчанию равно 0. |
Возвращаемое значение
Ответ при запросе всех участников списка
Отправка кампании (предварительная версия)
Отправка существующей кампании
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
кампания
|
campaign_id | True | string |
Уникальный идентификатор списка |
Подписка или отмена подписки участников списка
Пакетная подписка или отмена подписки участников списка.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор списка
|
list_id | True | string |
Уникальный идентификатор списка |
|
Пропустить проверку слияния
|
skip_merge_validation | boolean |
Позволяет принимать данные-члены без значений поля слияния |
|
|
Пропустить повторную проверку
|
skip_duplicate_check | boolean |
Пропускает дубликаты, отправленные в запросе |
|
|
Тип электронной почты
|
email_type | string |
Тип сообщения электронной почты, который попросил получить (html или text) |
|
|
Состояние
|
status | True | string |
Текущее состояние подписчика. Возможные значения: подписка, отмена подписки, очистка, ожидание |
|
Имя (Первое имя)
|
FNAME | string |
Имя подписчика |
|
|
Фамилия
|
LNAME | string |
Фамилия подписчика |
|
|
Language
|
language | string |
Если задано или обнаружено, язык подписчика |
|
|
ВИП
|
vip | boolean |
Состояние ВИРТУАЛЬНОГО IP-адреса для подписчика |
|
|
Широта
|
latitude | float |
Широта расположения |
|
|
Долгота
|
longitude | float |
Расположение долготы |
|
|
Электронная почта
|
email_address | True | string |
Адрес электронной почты для подписчика |
|
Обновление существующих элементов
|
update_existing | boolean |
Измените ли эта пакетная операция состояние подписки существующих участников. |
Возвращаемое значение
Ответ при подписке или отмене подписки элементов списка в пакете
Получение всех списков
Поиск всех списков для текущего пользователя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Максимальные результаты
|
count | integer |
Количество возвращаемых записей. Значение по умолчанию — 10. Максимальное значение равно 1000 |
|
|
Смещение
|
offset | integer |
Количество записей из коллекции для пропуска. Значение по умолчанию равно 0. |
Возвращаемое значение
Ответ при получении списков
Список кампаний
Эта операция извлекает список кампаний в учетной записи
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Кампании
|
campaigns | array of CampaignResponseModel |
Массив объектов, каждый из которых представляет кампанию |
Удаление участника из списка
Удаление элемента из списка.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор списка
|
list_id | True | string |
Уникальный идентификатор списка |
|
Электронная почта участника
|
member_email | True | string |
Адрес электронной почты участника, который нужно удалить |
Триггеры
| Добавление элемента в список |
Активирует рабочий процесс при добавлении нового члена в список |
| При создании нового списка |
Активирует рабочий процесс при создании нового списка |
Добавление элемента в список
Активирует рабочий процесс при добавлении нового члена в список
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор списка
|
list_id | True | string |
Уникальный идентификатор списка |
Возвращаемое значение
Ответ при получении элементов в списке
При создании нового списка
Активирует рабочий процесс при создании нового списка
Возвращаемое значение
Ответ при получении списков
Определения
Recipient
Параметры кампании
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор списка
|
list_id | string |
Уникальный идентификатор списка |
|
segment_opts
|
segment_opts | Segment_Opts |
Объект, представляющий все параметры сегментации |
Variate_Settings
Параметры кампании
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Критерии победы
|
winner_criteria | string |
Сочетание, которое выполняет лучшие. Это может быть определено автоматически по частоте щелчков, открытой ставке или общему доходу, или вы можете выбрать вручную на основе данных отчета, которые вы найдете наиболее ценными. Для многовариантных кампаний тестирования send_time winner_critera игнорируется. Для многовариантных кампаний с "вручную" в качестве winner_citeria победитель должен быть выбран в веб-приложении MailChimp |
|
Время ожидания
|
wait_time | integer |
Количество минут, которые нужно ждать, прежде чем выбрать победную кампанию. Значение wait_time должно быть больше 0 и в целых часах, указанных в минутах. |
|
Размер теста
|
test_size | integer |
Процент получателей для отправки сочетаний тестов должен быть значением от 10 до 100 |
|
Строки темы
|
subject_lines | array of string |
Возможные строки субъектов для тестирования. Если строки темы не указаны, settings.subject_line будет использоваться |
|
Время отправки
|
send_times | array of string |
Возможное время отправки для тестирования. Время должно быть в формате ГГГГ-MM-DD HH:MM:SS. Если send_times предоставляются для тестирования, test_size будет задано значение 100% и winner_criteria будет игнорироваться. |
|
Из имен
|
from_names | array of string |
Возможные из имен. Число предоставленных from_names должно соответствовать количеству reply_to_addresses. Если from_names не задано, settings.from_name будет использоваться |
|
Ответ на адреса
|
reply_to_addresses | array of string |
Возможные из имен. Число предоставленных from_names должно соответствовать количеству reply_to_addresses. Если from_names не задано, settings.from_name будет использоваться |
Отслеживание
Параметры кампании
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Открытия
|
opens | boolean |
Открывается ли отслеживание. По умолчанию используется значение true. Невозможно задать значение false для вариативных кампаний |
|
Отслеживание нажатия html
|
html_clicks | boolean |
Следует ли отслеживать щелчки в HTML-версии кампании. По умолчанию используется значение true. Невозможно задать значение false для вариативных кампаний |
|
Plain-Text отслеживание щелчка
|
text_clicks | boolean |
Следует ли отслеживать щелчки в обычной текстовой версии кампании. По умолчанию используется значение true. Невозможно задать значение false для вариативных кампаний |
|
Отслеживание целей MailChimp
|
goal_tracking | boolean |
Включение отслеживания целей |
|
Отслеживание e Commerce360
|
ecomm360 | boolean |
Включение отслеживания e Commerce360 |
|
Отслеживание Google Analytics
|
google_analytics | string |
Пользовательский slug для отслеживания Google Analytics (максимум 50 байт) |
|
Отслеживание аналитики ClickTale
|
clicktale | string |
Пользовательский slug для отслеживания ClickTale (максимум 50 байт) |
|
salesforce
|
salesforce | Salesforce |
Параметры отслеживания Salesforce для кампании. Необходимо использовать встроенную интеграцию Salesforce MailChimp |
|
highrise
|
highrise | Highrise |
Варианты отслеживания highrise для кампании. Необходимо использовать встроенную интеграцию Highrise MailChimp |
|
капсула
|
capsule | Capsule |
Варианты отслеживания капсул для кампании. Необходимо использовать встроенную интеграцию с Капсулой MailChimp |
RSS_Opts
Параметры RSS для кампании
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URL-адрес канала
|
feed_url | string |
URL-адрес веб-канала RSS |
|
Частота
|
frequency | string |
Частота кампании RSS |
|
Ограничение RSS-образов
|
constrain_rss_img | string |
Добавление CSS в образы в RSS-канале для ограничения их ширины в кампаниях |
|
планирование
|
schedule | Schedule |
Расписание отправки кампании RSS |
Social_Card
Параметры кампании
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URL-адрес изображения
|
image_url | string |
URL-адрес изображения заголовка карточки |
|
Описание кампании
|
description | string |
Краткая сводка кампании для отображения |
|
Название
|
title | string |
Заголовок карточки. Обычно тема кампании |
Segment_Opts
Объект, представляющий все параметры сегментации
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Сохраненный идентификатор сегмента
|
saved_segment_id | integer |
Идентификатор существующего сохраненного сегмента |
|
Тип совпадения
|
match | string |
Тип сопоставления сегментов: возможные значения: любые, все |
Salesforce
Параметры отслеживания Salesforce для кампании. Необходимо использовать встроенную интеграцию Salesforce MailChimp
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Кампания Salesforce
|
campaign | boolean |
Создание кампании в подключенной учетной записи Salesforce |
|
Заметка Salesforce
|
notes | boolean |
Обновление заметок контактов для кампании на основе адресов электронной почты подписчика |
Highrise
Варианты отслеживания highrise для кампании. Необходимо использовать встроенную интеграцию Highrise MailChimp
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Кампания Highrise
|
campaign | boolean |
Создание кампании в подключенной учетной записи Highrise |
|
Примечание Highrise
|
notes | boolean |
Обновление заметок контактов для кампании на основе адресов электронной почты подписчика |
Капсула
Варианты отслеживания капсул для кампании. Необходимо использовать встроенную интеграцию с Капсулой MailChimp
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Заметка о капсуле
|
notes | boolean |
Обновление заметок контактов для кампании на основе адресов электронной почты подписчика |
Расписание
Расписание отправки кампании RSS
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Отправка часа
|
hour | integer |
Час отправки кампании в местное время. Допустимые часы — 0–23. Например, "4" будет 4 утра в часовом поясе вашей учетной записи по умолчанию |
|
daily_send
|
daily_send | Daily_Send |
Дни недели для отправки ежедневной кампании RSS. |
|
Еженедельный день отправки
|
weekly_send_day | string |
День недели для отправки еженедельной кампании RSS |
|
День ежемесячной отправки
|
monthly_send_date | float |
День месяца для отправки ежемесячной кампании RSS. Допустимые дни 1-32, где "0" всегда является последним днем месяца. Месяцы с меньшим числом дней не будут отправляться в rsS-кампанию. Например, RSS-кампании, которые будут отправляться 30-й, не будут выходить в феврале |
Daily_Send
Дни недели для отправки ежедневной кампании RSS.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Воскресенье
|
sunday | boolean |
Отправляет ежедневную кампанию RSS в воскресенье |
|
Monday
|
monday | boolean |
Отправляет ежедневную кампанию RSS в понедельник |
|
Вторник
|
tuesday | boolean |
Отправляет ежедневную кампанию RSS во вторник |
|
Среда
|
wednesday | boolean |
Отправляет ежедневную кампанию RSS в среду |
|
Четверг
|
thursday | boolean |
Отправляет ежедневную кампанию RSS в четверг |
|
Пятница
|
friday | boolean |
Отправляет ежедневную кампанию RSS в пятницу |
|
Суббота
|
saturday | boolean |
Отправляет ежедневную кампанию RSS в субботу |
CampaignResponseModel
Новая модель результатов кампании
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор кампании
|
id | string |
Строка, которая однозначно идентифицирует эту кампанию |
|
Тип кампании
|
type | string |
Существует четыре типа кампаний, которые можно создать в MailChimp. Вместо этого следует использовать нерекомендуемые кампании A/B Split и вариативные кампании. |
|
Время создания
|
create_time | string |
Дата и время создания кампании |
|
URL-адрес архива
|
archive_url | string |
Ссылка на архивную версию кампании |
|
Состояние
|
status | string |
Ссылка на архивную версию кампании |
|
Отправленные сообщения электронной почты
|
emails_sent | integer |
Общее количество отправленных сообщений электронной почты для этой кампании |
|
Время отправки
|
send_time | string |
Время и дата отправки кампании |
|
Тип контента
|
content_type | string |
Как содержимое кампании объединяется ("шаблон", "drag_and_drop", "html", "URL-адрес") |
|
List
|
recipient | array of Recipient |
Список параметров для кампании |
|
settings
|
settings | SettingsV2 |
Параметры кампании |
|
variate_settings
|
variate_settings | Variate_Settings |
Параметры кампании |
|
слежение
|
tracking | Tracking |
Параметры кампании |
|
rss_opts
|
rss_opts | RSS_Opts |
Параметры RSS для кампании |
|
ab_split_opts
|
ab_split_opts | AB_Split_Opts |
Варианты тестирования A/B для кампании |
|
social_card
|
social_card | Social_Card |
Параметры кампании |
|
report_summary
|
report_summary | Report_Summary |
Для отправленных кампаний сводка по открытию, щелчкам и отмене подписки |
|
delivery_status
|
delivery_status | Delivery_Status |
Обновления для кампаний в процессе отправки |
|
_дюны
|
_links | array of Link |
Список типов ссылок и описаний для документов схемы API |
SettingsV2
Параметры кампании
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Строка темы кампании
|
subject_line | string |
Тема кампании |
|
Название
|
title | string |
Название кампании |
|
Имя
|
from_name | string |
Имя from в кампании (а не адрес электронной почты) |
|
Ответ на адрес
|
reply_to | string |
Адрес электронной почты для кампании |
|
Беседа
|
use_conversation | boolean |
Использование функции беседы MailChimp для управления ответами вне офиса |
|
Имя
|
to_name | string |
Имя кампании "To". Обычно поле слияния имени |
|
Идентификатор папки
|
folder_id | string |
Если кампания указана в папке, идентификатор этой папки |
|
Authentication
|
authenticate | boolean |
Проверка подлинности кампании в MailChimp. Значение по умолчанию имеет значение true |
|
Автоматический нижний колонтитул
|
auto_footer | boolean |
Автоматическое добавление нижнего колонтитула MailChimp по умолчанию в кампанию |
|
Встроенный CSS
|
inline_css | boolean |
Автоматически встраивайте CSS, включенные в содержимое кампании |
|
Автоматическое твита
|
auto_tweet | boolean |
Автоматически твит ссылки на страницу архива кампании при отправке кампании |
|
Автозапуск в Facebook
|
auto_fb_post | array of integer |
Массив идентификаторов страницы Facebook для автоматической публикации |
|
Комментарии в Facebook
|
fb_comments | boolean |
Разрешает комментарии Facebook по кампании (также принудительно включает панель инструментов архива кампании). Значение по умолчанию имеет значение true |
AB_Split_Opts
Варианты тестирования A/B для кампании
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Разделение теста
|
split_test | string |
Тип разделения AB для запуска |
|
Выбор победителя
|
pick_winner | string |
Как мы должны оценить победителя. На основе "открывается", "щелкает" или "вручную" |
|
Время ожидания
|
wait_units | string |
Как единица времени для измерения победителя ("часы" или "дни"). Это невозможно изменить после отправки кампании |
|
Время ожидания
|
wait_time | integer |
Время ожидания перед выбором победителя. Это невозможно изменить после отправки кампании |
|
Разделение размера
|
split_size | integer |
Размер разделенных групп. Кампании разделены на "расписание" вынуждены иметь 50/50 раскол. Допустимые целые числа разделены между 1–50 |
|
Из группы имен A
|
from_name_a | string |
Для кампаний, разделенных по имени, имя группы A |
|
Из группы имен B
|
from_name_b | string |
Для кампаний, разделенных на "From Name", имя группы B |
|
Группа ответов электронной почты A
|
reply_email_a | string |
Для кампаний, разделенных на "From Name", ответ на адрес группы A |
|
Ответная группа электронной почты B
|
reply_email_b | string |
Для кампаний, разделенных на "From Name", ответ на адрес группы B |
|
Группа строк темы A
|
subject_a | string |
Для кампаний, разделенных на "Тема линия", тема для группы A |
|
Группа строк темы B
|
subject_b | string |
Для кампаний, разделенных на "Тема строка", строка темы для группы B |
|
Группа времени отправки A
|
send_time_a | string |
Время отправки для группы A |
|
Группа времени отправки B
|
send_time_b | string |
Время отправки для группы B |
|
Победитель времени отправки
|
send_time_winner | string |
Время отправки для выигрышной версии |
Report_Summary
Для отправленных кампаний сводка по открытию, щелчкам и отмене подписки
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Открывается служба автоматизации
|
opens | integer |
Общее количество открытий для кампании |
|
Уникальные открытия
|
unique_opens | integer |
Число уникальных открытий |
|
Открытие ставки
|
open_rate | float |
Количество уникальных открытий, разделенное на общее количество успешных поставок |
|
Всего щелчков
|
clicks | integer |
Общее количество щелчков для кампании |
|
Уникальные щелчки подписчика
|
subscriber_clicks | float |
Количество уникальных щелчков |
|
Скорость нажатия кнопки
|
click_rate | float |
Количество уникальных щелчков, разделенных на общее количество успешных поставок |
Delivery_Status
Обновления для кампаний в процессе отправки
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Включена доставка staut
|
enabled | boolean |
Включена ли для этой учетной записи и кампании состояние доставки кампании |
|
Отмена кампании
|
can_cancel | boolean |
Можно ли отменить отправку кампании |
|
Состояние доставки кампании
|
status | string |
Текущее состояние доставки кампании |
|
Отправленные сообщения электронной почты
|
emails_sent | integer |
Общее количество подтвержденных сообщений электронной почты, отправленных для этой кампании до сих пор |
|
Отмененные сообщения электронной почты
|
emails_canceled | integer |
Общее количество отмененных сообщений электронной почты для этой кампании |
Link
Варианты отслеживания капсул для кампании. Необходимо использовать встроенную интеграцию с Капсулой MailChimp
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Rel
|
rel | string |
Как и атрибут HTML rel, это описывает тип ссылки |
|
Href
|
href | string |
Это свойство содержит полный URL-адрес, который можно вызвать для получения связанного ресурса или выполнения связанного действия. |
|
Метод
|
method | string |
Метод HTTP, который следует использовать при доступе к URL-адресу, определенному в файле href. (GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD) |
|
Целевая схема
|
targetSchema | string |
Для GETs это URL-адрес, представляющий схему, в соответствии с которым должен соответствовать ответ. |
|
Schema
|
schema | string |
Для методов HTTP, которые могут получать тела (POST и PUT), это URL-адрес, представляющий схему, которая должна соответствовать тексту. |
Контакт
Варианты отслеживания капсул для кампании. Необходимо использовать встроенную интеграцию с Капсулой MailChimp
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Название компании
|
company | string |
Имя компании для списка |
|
Адресная строка 1
|
address1 | string |
Адрес улицы для контакта списка |
|
Строка адреса 2
|
address2 | string |
Адрес улицы для контакта списка |
|
Город
|
city | string |
Город для контакта со списком |
|
Государство
|
state | string |
Состояние контакта списка |
|
Почтовый индекс
|
zip | string |
Почтовый или почтовый индекс для контакта списка |
|
Код страны
|
country | string |
Код страны с двумя символами ISO3166. Значение по умолчанию для США, если недопустимо |
|
Номер телефона
|
phone | string |
Номер телефона для контакта списка |
Campaign_Defaults
Варианты отслеживания капсул для кампании. Необходимо использовать встроенную интеграцию с Капсулой MailChimp
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя отправителя
|
from_name | string |
Значение по умолчанию для кампаний, отправленных в этот список |
|
Адрес электронной почты отправителя
|
from_email | string |
Значение по умолчанию из электронной почты для кампаний, отправленных в этот список |
|
Тема
|
subject | string |
Строка темы по умолчанию для кампаний, отправленных в этот список |
|
Language
|
language | string |
Язык по умолчанию для форм этих списков |
CreateNewListResponseModel
Создание модели результатов списка
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор списка
|
id | string |
Строка, которая однозначно идентифицирует этот список |
|
Имя списка
|
name | string |
Имя списка |
|
контакт
|
contact | Contact |
Варианты отслеживания капсул для кампании. Необходимо использовать встроенную интеграцию с Капсулой MailChimp |
|
Напоминание о разрешениях
|
permission_reminder | string |
Напоминание о разрешении для списка |
|
Использование архивной панели
|
use_archive_bar | boolean |
Используется ли кампания для этого списка архивной строкой в архивах по умолчанию |
|
campaign_defaults
|
campaign_defaults | Campaign_Defaults |
Варианты отслеживания капсул для кампании. Необходимо использовать встроенную интеграцию с Капсулой MailChimp |
|
Уведомление о подписке
|
notify_on_subscribe | string |
Адрес электронной почты для отправки уведомлений о подписке на |
|
Уведомление об отмене подписки
|
notify_on_unsubscribe | string |
Адрес электронной почты для отправки уведомлений об отмене подписки |
|
Дата создания
|
date_created | string |
Дата и время создания этого списка |
|
Оценка списка
|
list_rating | integer |
Автоматическая оценка действий для списка (0-5) |
|
Параметр типа электронной почты
|
email_type_option | boolean |
Поддерживает ли список несколько форматов для сообщений электронной почты. Если задано значение true, подписчики могут выбрать, хотите ли они получать HTML или текстовые сообщения электронной почты. Если задано значение false, подписчики получат HTML-сообщения электронной почты с альтернативным резервным копированием обычного текста. |
|
Короткий URL-адрес подписки
|
subscribe_url_short | string |
Сокращенная версия формы подписки этого списка EepURL |
|
Длинный URL-адрес подписки
|
subscribe_url_long | string |
Полная версия формы подписки этого списка (узел будет отличаться) |
|
Адрес луча
|
beamer_address | string |
Адрес Лучера электронной почты списка |
|
Видимость
|
visibility | string |
Является ли этот список общедоступным или частным |
|
Модули
|
modules | array of string |
Все модули для конкретного списка, установленные для этого списка |
|
статистика
|
stats | Stats |
Статистика для списка. Многие из них кэшируются по крайней мере пять минут |
|
Links
|
_links | array of Link |
Список типов ссылок и описаний для документов схемы API |
Статистика
Статистика для списка. Многие из них кэшируются по крайней мере пять минут
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Число элементов
|
member_count | integer |
Количество активных элементов в списке |
|
Отмена подписки
|
unsubscribe_count | integer |
Число участников, которые отписались из списка |
|
Очистка счетчика
|
cleaned_count | integer |
Количество элементов, очищенных из списка |
|
Число участников с момента отправки
|
member_count_since_send | integer |
Число активных участников списка с момента отправки последней кампании |
|
Отмена подписки с момента отправки
|
unsubscribe_count_since_send | integer |
Число участников, которые отписались с момента последней кампании |
|
Очистка счетчика после отправки
|
cleaned_count_since_send | integer |
Количество участников, очищенных из списка с момента отправки последней кампании |
|
Количество кампаний
|
campaign_count | integer |
Количество кампаний в любом состоянии, использующее этот список |
|
Последняя отправка кампании
|
campaign_last_sent | date-time |
Дата и время отправки последней кампании в этот список |
|
Слияние счетчика var
|
merge_field_count | integer |
Количество вар слиянием для этого списка (не сообщение электронной почты, которое является обязательным) |
|
Средняя ставка подписки
|
avg_sub_rate | float |
Среднее количество подписок в месяц для списка (если вы еще не вычислили его) |
|
Средняя частота отмены
|
avg_unsub_rate | float |
Среднее число отмены подписки в месяц для списка (не возвращено, если вы не вычислили его еще) |
|
Целевая ставка подписки
|
target_sub_rate | float |
Целевое число подписок в месяц для списка, чтобы сохранить его рост (если вы еще не вычислили его) |
|
Открытие ставки
|
open_rate | float |
Средняя ставка открытия (процент, представленный как число от 0 до 100) на кампанию для списка (не возвращается, если она еще не вычисляется). |
|
Скорость нажатия кнопки
|
click_rate | float |
Средняя частота щелчков (процент, представленный как число от 0 до 100) на кампанию для списка (не возвращается, если мы еще не вычислили его). |
|
Дата последней подписки на список
|
last_sub_date | string |
Дата и время последнего подписки на этот список |
|
Дата отмены подписки на последний список
|
last_unsub_date | string |
Дата и время последнего отмены подписки из этого списка |
GetListsResponseModel
Ответ при получении списков
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Lists
|
lists | array of CreateNewListResponseModel |
Массив объектов, каждый из которых представляет список |
|
Количество элементов
|
total_items | integer |
Общее количество элементов, соответствующих запросу, независимо от разбиения на страницы |
FirstAndLastName
Объединенные поля, содержащие имя пользователя и фамилию
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя (Первое имя)
|
FNAME | string |
Имя подписчика |
|
Фамилия
|
LNAME | string |
Фамилия подписчика |
Местоположение
Сведения о расположении подписчика
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Широта
|
latitude | float |
Широта расположения |
|
Долгота
|
longitude | float |
Расположение долготы |
MemberResponseModel
Модель результатов члена
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код электронной почты
|
id | string |
Хэш MD5 нижней версии адреса электронной почты члена списка |
|
Электронная почта
|
email_address | string |
Адрес электронной почты для подписчика |
|
Уникальный идентификатор электронной почты
|
unique_email_id | string |
Идентификатор адреса для всех MailChimp |
|
Тип электронной почты
|
email_type | string |
Тип сообщения электронной почты, который попросил получить (html или text). |
|
Состояние
|
status | string |
Текущее состояние подписчика. Возможные значения: подписка, отмена подписки, очистка, ожидание |
|
merge_fields
|
merge_fields | FirstAndLastName |
Объединенные поля, содержащие имя пользователя и фамилию |
|
статистика
|
stats | Stats |
Статистика для списка. Многие из них кэшируются по крайней мере пять минут |
|
IP-адрес регистрации
|
ip_signup | string |
IP-адрес подписчика, зарегистрированный из |
|
Метка времени регистрации
|
timestamp_signup | string |
Дата и время регистрации подписчика в списке |
|
Ip-адрес для согласия
|
ip_opt | string |
IP-адрес подписчика, используемый для подтверждения их состояния согласия |
|
Включение метки времени
|
timestamp_opt | string |
Дата и время подписки подтвердили свое согласие |
|
Рейтинг участников
|
member_rating | integer |
Оценка звезды для этого члена в диапазоне от 1 до 5 |
|
Дата последнего изменения
|
last_changed | string |
Дата и время последнего изменения сведений о члене |
|
Language
|
language | string |
Если задано или обнаружено, язык подписчика |
|
ВИП
|
vip | boolean |
Состояние ВИРТУАЛЬНОГО IP-адреса для подписчика |
|
Клиент электронной почты
|
email_client | string |
Клиент электронной почты участника списка |
|
location
|
location | Location |
Сведения о расположении подписчика |
|
last_note
|
last_note | Last_Note |
Последние заметки, добавленные об этом элементе |
|
Идентификатор списка
|
list_id | string |
Идентификатор списка |
|
Links
|
_links | array of Link |
Список типов ссылок и описаний для документов схемы API |
Last_Note
Последние заметки, добавленные об этом элементе
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор заметки
|
note_id | integer |
Идентификатор заметки |
|
Время создания
|
created_at | string |
Дата создания заметки |
|
Author
|
created_by | string |
Автор заметки |
|
Замечание
|
note | string |
Содержимое заметки |
GetAddMembersBatchResponseModel
Ответ при подписке или отмене подписки элементов списка в пакете
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Всего создано
|
total_created | integer |
Общее количество участников, добавленных в список |
|
Всего обновлено
|
total_updated | integer |
Общее число существующих участников списка, состояние подписки которого было обновлено |
|
Число ошибок
|
error_count | integer |
Номера адресов электронной почты, которые не удалось добавить в список или обновить |
GetAllMembersResponseModel
Ответ при запросе всех участников списка
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Members
|
members | array of MemberResponseModel |
Массив объектов, каждый из которых представляет определенный элемент списка |
|
Идентификатор списка
|
list_id | string |
Идентификатор списка |
|
Всего элементов
|
total_items | integer |
Общее количество элементов, соответствующих запросу, независимо от разбиения на страницы |
GetMembersResponseModel
Ответ при получении элементов в списке
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Members
|
members | array of AddUserResponseModel |
Массив объектов, каждый из которых представляет определенный элемент списка |
AddUserResponseModel
Новая модель результатов кампании
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код электронной почты
|
id | string |
Хэш MD5 нижней версии адреса электронной почты члена списка |
|
Электронная почта
|
email_address | string |
Адрес электронной почты для подписчика |
|
Уникальный идентификатор электронной почты
|
unique_email_id | string |
Идентификатор адреса для всех MailChimp |
|
Тип электронной почты
|
email_type | string |
Тип сообщения электронной почты, который попросил получить (html или text). |
|
Состояние
|
status | string |
Текущее состояние подписчика. Возможные значения: подписка, отмена подписки, очистка, ожидание |
|
merge_fields
|
merge_fields | FirstAndLastName |
Объединенные поля, содержащие имя пользователя и фамилию |
|
статистика
|
stats | Stats |
Статистика для списка. Многие из них кэшируются по крайней мере пять минут |
|
IP-адрес регистрации
|
ip_signup | string |
IP-адрес подписчика, зарегистрированный из |
|
Метка времени регистрации
|
timestamp_signup | string |
Дата и время регистрации подписчика в списке |
|
Ip-адрес для согласия
|
ip_opt | string |
IP-адрес подписчика, используемый для подтверждения их состояния согласия |
|
Включение метки времени
|
timestamp_opt | string |
Дата и время подписки подтвердили свое согласие |
|
Рейтинг участников
|
member_rating | integer |
Оценка звезды для этого члена в диапазоне от 1 до 5 |
|
Дата последнего изменения
|
last_changed | string |
Дата и время последнего изменения сведений о члене |
|
Language
|
language | string |
Если задано или обнаружено, язык подписчика |
|
ВИП
|
vip | boolean |
Состояние ВИРТУАЛЬНОГО IP-адреса для подписчика |
|
Клиент электронной почты
|
email_client | string |
Клиент электронной почты участника списка |
|
location
|
location | Location |
Сведения о расположении подписчика |
|
last_note
|
last_note | Last_Note |
Последние заметки, добавленные об этом элементе |
|
Идентификатор списка
|
list_id | string |
Идентификатор списка |
|
Links
|
_links | array of Link |
Список типов ссылок и описаний для документов схемы API |