Обновить лист подписчиков

/v2/Api/Lists PUT

Этот метод позволяет редактировать практически все параметры существующего списка подписчиков (включая его название).

Что не может быть изменено:

  • Тип списка (обычный / тестовый)
  • Настройка режима подписки (без подтверждения/с подтверждением)
  • Письма, используемые для подтверждения и напоминания (для подписки с подтверждением)

Чтобы выполнить метод, используйте PUT запрос:

https://api.esv2.com/v2/Api/Lists/{List ID}

Вам нужен идентификатор списка, чтобы изменить настройки списка. Идентификатор списка возвращается при использовании API для создания списка. Его также можно найти интерфейсе.

Тело запроса должно быть в формате XML с аналогичной структурой, используемой для создания списков (см https://manual.expertsender.ru/metody/dejstviya-s-listami/sozdat-list-podpiski)

Смотрите примеры ниже.

При построении тела запроса XML соблюдаются следующие правила:

  1. Параметры, которые опущены, будут оставлены без изменений.
  2. Параметры, которые присутствуют, но пустые, будут очищены (если они не требуются).
  3. Параметры, которые присутствуют и не пустые, будут обновлены.
  4. Применяются все обычные правила проверки.

Пример 1: простой запрос (изменение только имени списка):

PUT https://api.esv2.com/v2/Api/Lists/ HTTP/1.1
<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>

Пример 2: полный запрос со всеми возможными опциями:

PUT https://api.esv2.com/v2/Api/Lists/ HTTP/1.1
<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>Описание</Description>
	   <Language>ru-RU</Language>
	   <Charset>UTF-8</Charset>
	   <SubscriptionConfirmPageUrl>http://www.domain.com/confirm</SubscriptionConfirmPageUrl>
	   <SubscriptionThankYouPageUrl>http://www.domain.com/thankyou</SubscriptionThankYouPageUrl>
	   <RemovalPageUrl>http://www.domain.com/removal</RemovalPageUrl>
	   <PreferencesChangeUrl>http://www.domain.com/preferences</PreferencesChangeUrl> 
     </GeneralSettings>
	<AddressSettings>
	  <Company>Компания</Company>
	  <Address>адрес1</Address>
	  <Address2>адрес2</Address2>
	  <City>Город</City>
	  <ZipPostalCode>100000</ZipPostalCode>
	  <StateProvinceRegion>Область/регион/штат</StateProvinceRegion>
	  <Country>Страна</Country>
	</AddressSettings>
   <SubscriberSettings>
      <DefaultSubscriberName>Полное имя по умолчанию</DefaultSubscriberName>
	  <DefaultSubscriberFirstname>имя по умолчанию</DefaultSubscriberFirstname>
	  <DefaultSubscriberLastname>фамилия по умолчанию</DefaultSubscriberLastname>
	  <FrequencyCappingTimeEmail>3</FrequencyCappingTimeEmail>
	  <DisableStandardMessageFooter>true</DisableStandardMessageFooter>
	  <DisableListUnsubscribeHeader>true</DisableListUnsubscribeHeader>
	  <AskBeforeUnsubscribing>true</AskBeforeUnsubscribing>
      <HideListInPreferenceCenter>true</HideListInPreferenceCenter>       
    </SubscriberSettings>       
     <DomainSettings>
	  <ClickTrackingDomain>click.domain.com</ClickTrackingDomain>
     </DomainSettings>  
   </Data> 
</ApiRequest>

Пример 3: Очистка параметров:

PUT https://api.esv2.com/v2/Api/Lists/ HTTP/1.1
<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <ApiKey>Ваш_API_ключ</ApiKey>
   <Data>
     <GeneralSettings>
       <FriendlyName></FriendlyName>
     </GeneralSettings>
	  <SubscriberSettings>
	    <DefaultSubscriberName></DefaultSubscriberName>
	  </SubscriberSettings>  
   </Data> 
</ApiRequest>

Ответ:

Успешный запрос вернет HTTP-код 204 без какого-либо содержимого:

HTTP/1.1 204 No Content
Cache-Control: private
Access-Control-Allow-Origin: *
Date: Thu, 19 Sep 2019 15:26:27 GMT