Subscriber.Unsubscribe
Описание
Отписать подписчика из списка
Параметры запроса
- SessionID = {string} (optional)
- Session ID необходим для аутентификации. Обязателен только для десктоп приложений
- Command = {Subscriber.Unsubscribe} (обязательный)
- API команда
- ResponseFormat = {JSON | XML} (обязательный)
- Формат ответа
- JSONPCallBack = {bool}
- Используется для междоменной передачи. Узнать о JSONP можно по ссылке: http://ru.wikipedia.org/wiki/JSONP
- ListID = {integer} (обязательный)
- ID списка
- CampaignID = {integer} (обязательный)
- Если ссылка сгенерирована для письма кампании, ID кампании должно быть представлено для обновления статистики
- EmailID = {integer}
- Если представлено ID письма, статистика отписки будет привязана к этому письму и владельцу А/Б сплит-кампании
- SubscriberID = {integer} (обязательный)
- ID подписчика или его email должны быть представлены
- EmailAddress = {string} (обязательный)
- ID подписчика или его email должны быть представлены
- IPAddress = {string} (обязательный)
- IP адрес пользователя, запросившего отписку
- Preview = {1 | 0} (обязательный)
- Если 1, процесс отмены подписки будет имитирован (симуляция)
Параметры ответа
- Success = {true | false}
- Состояние - успешно или ошибка
- RedirectURL = {string}
- Целевой URL куда перенаправить после завершения процесса
- ErrorCode = {integer}
- Код ошибки
Коды ошибок
- 1
- ID списка подписчиков не найден
- 2
- IP адрес не найден
- 3
- Email адрес or subscriber ID must be provided
- 4
- Недействительный ID списка
- 5
- Недействительная информация пользователя
- 6
- Недействительный формат email
- 7
- Недействительный ID или email подписчика. Информация о подписчике не найдена в БД.
- 8
- Недействительный ID кампании
- 9
- Email адрес уже отписан.
- 10
- Недействительный ID письма
- 99998
- Ошибка авторизации или истекла сессия
- 99999
- Недостаточно прав
