Campaign.Update

Описание

Обновить параметры кампании

Параметры запроса

SessionID = {string} (обязательный)
Session ID необходим для аутентификации. Обязателен только для десктоп приложений
Command = {Campaign.Update} (обязательный)
API команда
ResponseFormat = {JSON | XML} (обязательный)
Формат ответа
JSONPCallBack = {bool}
Используется для междоменной передачи. Узнать о JSONP можно по ссылке: http://ru.wikipedia.org/wiki/JSONP
CampaignID = {integer} (обязательный)
Campaign ID to update
CampaignStatus = {Draft | Ready | Sending | Paused | Pending Approval | Sent | Failed} (обязательный)
Установить статус кампании
CampaignName = {string} (обязательный)
Название кампании
RelEmailID = {integer} (обязательный)
Письмо кампании (ID письма)
ScheduleType = {Not Scheduled | Immediate | Future | Recursive} (обязательный)
Тип планировщика
SendDate = {YYYY-MM-DD} (обязательный)
Дата отправки кампании
SendTime = {HH: MM: SS} (обязательный)
Время отправки кампании
SendTimeZone = {string} (обязательный)
Часовой пояс запланированной даты
ScheduleRecDaysOfWeek = {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7} (обязательный)
(Рекурсивное планирование) значения, разделенные запятой (,). Укажите 0 если ежедневно
ScheduleRecDaysOfMonth = {0 | 1 | 2 | 3 | 4 | 5 | ... | 31} (обязательный)
(Рекурсивное планирование) разделенные запятой (,). Укажите 0 если ежедневно
ScheduleRecMonths = {0 | 1 | 2 | ... | 12} (обязательный)
(Рекурсивное планирование) разделенные запятой (,). Укажите 0 если ежемесячно
ScheduleRecHours = {0 | 1 | 2 | ... | 23} (обязательный)
(Рекурсивное планирование) разделенные запятой (,) часы
ScheduleRecMinutes = {0 | 1 | 2 | ... | 59} (обязательный)
(Рекурсивное планирование) разделенные запятой (,) минуты
ScheduleRecSendMaxInstance = {integer} (обязательный)
(Рекурсивное планирование) количество повторных отправок кампании (Укажите 0 если бесконечное)
ApprovalUserExplanation = {string} (обязательный)
Объяснения пользователя по кампании, если кампания находится на рассмотрении
GoogleAnalyticsDomains = {string} (обязательный)
Домены для отслеживания в Google Analytics и Яндекс Метрике (домены, разделенные переносом строки (\n))
RecipientListsAndSegments = {string} (обязательный)
Целевые списки и сегменты. Все сегменты и списки разделены запятой.
Формат: ListID:SegmentID, ListID:SegmentID
Пример: 3:0, 3:2

Параметры ответа

Success = {true | false}
Состояние - успешно или ошибка
ErrorCode = {integer}
Код ошибки

Коды ошибок

1
ID кампании не найден
2
Недействительный ID кампании
3
Invalid campaign status value
4
Недействительный email ID
5
Недействительное значение типа планировщика кампании
6
Отсутствует дата отправки
7
Отсутствует время отправки
8
Должен быть указан день месяца или день недели для рекурсивного планирования
9
Нужно указать месяцы для рекурсивного планирования
10
Нужно указать часы для рекурсивного планирования
11
Нужно указать минуты для рекурсивного планирования
12
Нужно указать количество повторений для рекурсивного планирования
13
Часовой пояс для планировщика не указан
99998
Ошибка авторизации или истекла сессия
99999
Недостаточно прав