• Главная
• Ресурсы
• Документация
• API
• unsubscribe

unsubscribe(contact_type, contact, list_ids)

Метод отписывает e-mail или телефон подписчика от одного или нескольких списков. В отличие от метода exclude, он не исключает при этом контакт из списков, а помечает контакт как "отписавшийся". Вернуть статус на "активный" через API нельзя - это может сделать только сам подписчик, перейдя по ссылке активации из письма.

Мы рекомендуем использовать метод unsubscribe в случае, когда сам подписчик отказывается от подписки, и метод exclude в случае, когда управление подпиской/отпиской выполняется по инициативе отправителя.

Пример вызова

http://api.unisender.com/ru/api/unsubscribe?format=json&api_key=KEY&list_ids=134,135&contact_type=email&contact=test@example.org

Возвращаемое значение

Пустой объект в случае успеха. Если возникнут ошибки или предупреждения, они будут возвращены стандартным способом.

Аргументы

contact_type*

Обязательный аргумент - тип отписываемого контакта - либо 'email', либо 'phone'.

contact*

Обязательный аргумент - e-mail либо телефон, который отписываем.

list_ids

Перечисленные через запятую коды списков, от которых мы отписываем подписчика. Внимание - если аргумент отсутствует или пуст, то контакт будет отписан и от всех существующих списков, и от всех созданных в будущем. Коды списков можно узнать с помощью метода getLists. Они совпадают с кодами, используемыми в форме подписки.

Знаком * отмечены обязательные аргументы.