Метод исключает e-mail или телефон контакта из одного или нескольких списков. В отличие от метода unsubscribe, он не помечает контакт как "отписавшийся", и его позднее снова можно включить в список с помощью метода subscribe.
Мы рекомендуем использовать метод exclude в случае, когда управление подпиской/отпиской выполняется по инициативе отправителя (то есть вас, автора рассылки), и метод unsubscribe в случае, когда сам контакт отказывается от подписки.
Принцип использования
| Синтаксис URL для вызова метода |
| exclude (string contact_type, string contact [, string list_ids]) |
| https://api.unisender.com/ru/api/exclude?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 * | Email или телефон, который исключаем.
Примеры: contact=test@example.org contact=89091234567 |
| list_ids | Перечисленные через запятую коды списков, из которых мы исключаем контакта. Если не указаны, то исключаем из всех списков. Коды списков можно узнать с помощью метода getLists. Они совпадают с кодами, используемыми в форме подписки.
Примеры: list_ids=662572 list_ids=112233,887789,6665576 |
| Возвращаемое значение |
| Пустой объект в случае успеха. Если возникнут ошибки или предупреждения, они будут возвращены стандартным способом. При попытке исключить адрес из списка, в котором адрес отсутствует, будет возвращена ошибка: {
"error":"Contact "no_such@address.com" not found",
"code":"unspecified",
"result":""
}
|
