Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

Метод unsubscribe

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

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

Принцип использования

Синтаксис и URL для вызова метода
unsubscribe (string contact_type, string contact, string list_ids)
https://api.unisender.com/ru/api/unsubscribe?format=json&api_key=KEY&contact=test@example.org&contact_type=
TYPE&list_ids=134,135
Аргументы
api_key * Ключ доступа к API.
contact_type * Тип отписываемого контакта — либо ’email’, либо ‘phone’.

Примеры:

contact_type=email
contact_type=phone
contact * E-mail или телефон, который надо отписать от рассылок.

Примеры:

contact=test@example.org
contact=89091234567
list_ids Перечисленные через запятую коды списков, от которых мы отписываем контакт. Если коды не указаны, то отписываем контакт от всех списков, в которых он находится на момент запроса. Контакт отписывается именно от списков, но статус контакта для аккаунта не меняется. Для изменения статуса в аккаунте используйте метод importContacts со значением параметра email_status=’unsubscribed’.

Коды списков можно узнать с помощью метода getLists. Они совпадают с кодами, используемыми в форме подписки.

Примеры:

list_ids=662572
list_ids=112233,887789,6665576
Возвращаемое значение
Пустой объект в случае успеха. Если возникнут ошибки или предупреждения, они будут возвращены стандартным способом.
При попытке отписать адрес от списка, в котором адрес отсутствует, будет возвращена ошибка:

{
  "error":"Contact "no_such@address.com" not found",
  "code":"unspecified",
  "result":""
}
Оцените, на сколько вам показалась полезной статья «Метод unsubscribe»
(0)