Метод для создания нового списка контактов.
Предполагается, что каждый список задаёт отдельную тематику рассылок. Контакт может подписаться или отписатьcя от рассылки определённой тематики, поставив или убрав галочку напротив списка на странице управления подпиской, доступной по ссылке в письме. Поэтому неправильной практикой будет создание нового списка для каждой новой рассылки.
У каждого списка контактов в одном аккаунте Unisender должно быть уникальное имя. При попытке создания списка с повторяющимся именем будет возвращена ошибка.
В случае необходимости изменения списка адресатов перед рассылкой рассмотрите возможность использования методов importContacts / exportContacts, либо указания конкретных адресов/телефонов в методе createCampaign.
Принцип использования
| Синтаксис и URL для вызова метода |
| createList (string title, [string before_subscribe_url, string after_subscribe_url]) |
| https://api.unisender.com/ru/api/createList?format=json&api_key=KEY&title=NewListName |
| Аргументы | |
| api_key * | Ключ доступа к API. |
| title * | Название списка. Должно быть уникальным в вашем аккаунте.
Примеры: title=NewListTitle title=%D0%9D%D0%BE%D0%B2%D1%8B%D0%B9 («Новый» в кодировке UTF-8) |
| before_subscribe_url | URL для редиректа на страницу «перед подпиской». Обычно на этой странице показывается сообщение, что контакту надо перейти по ссылке подтверждения для активации подписки. В этот URL можно добавлять поля подстановки - например, вы можете идентифицировать контакта по email-адресу, подставив сюда email - либо по коду контакта в своей базе данных, сохраняя код в дополнительное поле и подставляя его в этот URL. |
| after_subscribe_url | URL для редиректа на страницу «после подписки». Обычно на этой странице показывается сообщение, что подписка успешно активирована. В этот URL можно добавлять поля подстановки - например, вы можете идентифицировать контакта по email-адресу, подставив сюда email - либо по коду контакта в своей базе данных, сохраняя код в дополнительное поле и подставляя его в этот URL. |
| Возвращаемое значение |
| Объект с полем id (кодом списка). Этот id далее можно использовать в прочих методах, где требуется id списка контактов.
Пример успешного создания нового списка контактов: {"result":{"id":353358}}
Пример ошибки: {
"error": "VM161103-01 [List "Test List" already exists]",
"code": "invalid_arg"
}
|
