/v2/Api/Lists POST

Позволяет создать новый лист подписчиков.

Формат запроса

Запрос для создания нового листа подписчиков.

Элементы тега Data:

Элемент/атрибут Тип Описание
GeneralSettings complex Основные настройки листа. Обязательный.
AddressSettings complex Настройки адреса для листа. Необязательный.
SubscriberSettings complex Дополнительные настройки подписчиков. Необязательный.
DomainSettings complex Настройки домена. Необязательный.
ConfirmationEmail complex Настройки письма подтверждения.

Элементы тега GeneralSettings:

Элемент/атрибут Тип Описание
IsSeedListbooleanОтмечает созданный список, как сидовый или обычный.По умолчанию «false» (обычный список).
Name string Имя листа. Максимальная длина — 50 символов. Обязательный.
FriendlyName string Имя листа, видимое для подписчиков. Максимальная длина — 50 символов. Необязательный.
Description string Внутреннее описание листа. Необязательный.
Language string Язык листа. Влияет на колонтитулы, форматы дат/чисел и так далее. Значение по умолчанию — «en-US». Необязательный. Список доступных языков ниже.
OptInMode string Выбор режима. Значение по умолчанию — «SingleOptIn»*. Может быть задан как «DoubleOptIn» для списка, в котором необходима отправка подтверждения подписки.
Charset string Кодировка для емейла. По умолчанию — «UTF-8». Список доступных кодировок ниже.
SubscriptionConfirmPageUrl string URL, на который перенаправляет после подписки на лист. Необязательный. По умолчанию — пустой (нет редиректа).
SubscriptionThankYouPageUrl string URL, на который перенаправляет после подтверждения подписки на лист. Необязательный. По умолчанию — пустой (нет редиректа).
RemovalPageUrl string URL, на который перенаправляет после отписки от листа. Не обязательный. По умолчанию — пустой (нет редиректа).
PreferencesChangeUrl string URL на который перенаправляет после изменения свойств через центр подписок. Необязательный. По умолчанию — пустой (нет редиректа).
*SingleOptIn - режим без подтверждения подписки.

Поддерживаемые языки:

Язык
en-US (английский)
pl-PL (польский)
ru-RU (русский)

Поддерживаемые кодировки:

Кодировка
UTF-8
ISO-8859-1
ISO-8859-2

Язык и кодировка могут быть изменены. Пожалуйста, пишите нам, если нужного вам языка или кодировки нет в списке.

Элементы тега AddressSettings:

Элемент/атрибут Тип Описание
Company string Имя компании. Необязательный.
Address string Физический адрес компании. Необязательный.
Address2 string Юридический адрес компании. Необязательный.
City string Город. Необязательный.
ZipPostalCode string Почтовый индекс. Необязательный.

Элементы тега SubscriberSettings:

Элемент/атрибут Тип Описание
DefaultSubscriberNamestringИмя и фамилия подписчика по умолчанию, если их нет в базе данных.
DefaultSubscriberFirstnamestringЗначение поля имя подписчика по умолчанию.
DefaultSubscriberLastnamestringЗначение поля фамилия подписчика по умолчанию.
FrequencyCappingTime integer Минимальное время в часах между отправкой двух сообщений одному подписчику. Необязательный. По умолчанию «0»
DisableStandardMessageFooter boolean Если установлен «true», то сообщения этому листу будут отправляться без футера по умолчанию. Необязательный. По умолчанию «false».
AskBeforeUnsubscribing boolean Если установлен «true», то будет запрошено подтверждение отписки от листа. Необязательный. По умолчанию «false».

Элементы тега DomainSettings:

Элемент/атрибутТипОписание
ClickTrackingDomainstringДомен, который будет использоваться в ссылках в рассылках по этому листу. Необязательный. По умолчанию используется стандартный.

Элементы тега ConfirmationEmail:

Элемент/атрибутТипОписание
FromNamestringИмя отправителя, которое используется в From: письма с подтверждением подписки. Обязательный.
FromEmailstringЕмейл отправителя, который используется в From: письма с подтверждением подписки. Обязательный.
SubjectstringТема письма подтверждения подписки. Обязательный.
HtmlstringHTML-контент письма подтверждения. Должен быть заключен в секцию CDATA для передачи в xml. Смотрите примеры. Обязательный.*
PlainstringТекстовое содержимое письма подтверждения. Обязательный.*

*В некоторых почтовых клиентах, которые не поддерживают html, отображается только текстовая версия письма. Чтобы все подписчики могли получить ваше сообщение, письмо "Подтверждение" должно содержать и HTML, и текстовый контент.

Ответ

Создает новый лист подписчиков. Метод возвращает ID созданного листа подписчиков. ID можно использовать, например, для планирования импорта в этот лист.

Элемент/атрибутТипОписание
(Data element content)intID созданного листа.

Примеры

Создать лист подписчиков с опциями по умолчанию

Запрос:

POST https://api.esv2.com/v2/Api/Lists HTTP/1.1 
Accept-Encoding: gzip,deflate 
Content-Type: application/xml 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com 
Content-Length: 358 
 
 
<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <ApiKey>Ваш_API_ключ</ApiKey>
   <Data>
     <GeneralSettings>
       <Name>Тестовый лист по API</Name>
     </GeneralSettings>
   </Data> 
</ApiRequest>

Ответ:

HTTP/1.1 201 Created 
Cache-Control: private 
Content-Type: text/xml; charset=utf-8 
Server: Microsoft-IIS/7.5 
X-AspNetMvc-Version: 3.0 
X-AspNet-Version: 4.0.30319 
X-Powered-By: ASP.NET 
Date: Thu, 05 Apr 2012 15:25:57 GMT 
Content-Length: 147 
 
 
 <ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <Data>33</Data>
 </ApiResponse>

Создать лист подписчиков с полными опциями

Запрос:

POST https://api.esv2.com/v2/Api/Lists HTTP/1.1 
Accept-Encoding: gzip,deflate 
Content-Type: application/xml 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com 
Content-Length: 2023 
 
 
 <ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <ApiKey>Ваш_API_ключ</ApiKey>
   <Data>
     <GeneralSettings>
       <Name>Тестовый лист по API</Name>
       <FriendlyName>Лучшие предложения!</FriendlyName>
       <Description>Это тестовый лист, созданный с помощью API</Description>
       <Language>en-US</Language>
       <OptInMode>DoubleOptIn</OptInMode>
       <Charset>ISO-8859-1</Charset>
       <SubscriptionConfirmPageUrl>http://www.test.com</SubscriptionConfirmPageUrl>
       <SubscriptionThankYouPageUrl>http://www.test.com</SubscriptionThankYouPageUrl>
       <RemovalPageUrl>http://www.test.com</RemovalPageUrl>
       <PreferencesChangeUrl>http://www.test.com</PreferencesChangeUrl>
     </GeneralSettings>
     <AddressSettings>
       <Company>TestCompany</Company>
       <Address>Test Blvd.</Address>
       <Address2>123</Address2>
       <City>New York</City>
       <ZipPostalCode>12345</ZipPostalCode>
       <StateProvinceRegion>CA</StateProvinceRegion>
       <Country>USA</Country>
     </AddressSettings>
     <SubscriberSettings>
       <FrequencyCappingTime>12</FrequencyCappingTime>
       <DisableStandardMessageFooter>true</DisableStandardMessageFooter>
       <DisableListUnsubscribeHeader>true</DisableListUnsubscribeHeader>
       <AskBeforeUnsubscribing>true</AskBeforeUnsubscribing>
     </SubscriberSettings>
     <DomainSettings>
       <ClickTrackingDomain>testdomain.com</ClickTrackingDomain>
     </DomainSettings>
     <ConfirmationEmail>
       <FromName>Test</FromName>
       <FromEmail>test@test.pl</FromEmail>
       <Subject>to jest testowy subject</Subject>
       <Html>
         <![CDATA[<a href="*[link_confirm]*">Confirm subscription</a>]]>
       </Html>
       <Plain>Confirm your subscription: *[link_confirm]*</Plain>
     </ConfirmationEmail>
   </Data>
 </ApiRequest>