Пользовательское событие кампании

/v2/Api/WorkflowCustomEvents POST

Пользовательское событие кампании (WorkflowCustomEvents) позволяет добавить подписчиков в кампанию. Для любой кампании может быть определено несколько пользовательских событий. Если событие используется в нескольких кампаниях, его срабатывание добавляет подписчика в каждую из них.

Рабочий пример - есть событие с названием "Завершение покупки". Мы можем применить его для запуска нескольких кампаний для одного подписчика, например, "Пост-продажные коммуникации" или "Специальные предложения".

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

Элементы тега дата

Элемент/Атрибут	Тип	Описание
CustomEventId	int	ID пользовательского события кампании. Обязательный.
SubscriberId	int	ID подписчика запускающего событие. Выборочный.*
CustomSubscriberId	int	Пользовательский идентификатор подписчика запускающего событие. Выборочный.*
SubscriberEmail	string	Email подписчика запускающего событие. Выборочный.*
DataFields	complex	Набор полей данных относящихся к событию. Необязательный.

*Для идентификации пользователя можно использовать или SubscriberId подпсичика или CustomSubscriberId подписчика, или SubscriberEmail. Если указаны оба значения, будет использован SubscriberId.

Элементы тега DataField

Элемент/Атрибут	Тип	Описание
Name	string	Имя поля данных. Обязательный.
Type	string	Тип поля данных. Обязательный. Может быть следующим: Text, например: "foobar" Number, например: 123 Date, дата в формате YYYY-MM-DD , например: 2015-11-26 Datetime,дата в формате YYYY-MM-DD hh:mm:ss, например: 2015-11-26 12:00:00 Boolean, логическое, например: true, false, 1, 0
Value	string	Значение поля данных. Обязательный.

Формат ответа:

При успешным выполнении запроса возвращается HTTP code "201 Created".

Примеры

Простой запрос без полей данных

POST https://api.esv2.com/v2/Api/WorkflowCustomEvents HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/xml;charset=UTF-8
Content-Length: 258
Host: api.esv2.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <ApiKey>Ваш_API-ключ</ApiKey>
  <Data>
    <CustomEventId>1</CustomEventId>
    <SubscriberId>1</SubscriberId>
  </Data>
</ApiRequest>

Запрос с полями данных

POST https://api.esv2.com/v2/Api/WorkflowCustomEvents HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/xml;charset=UTF-8
Content-Length: 1002
Host: api.esv2.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <ApiKey>Ваш_API-ключ</ApiKey>
  <Data>
    <CustomEventId>1</CustomEventId>
    <SubscriberId>1</SubscriberId>
    <DataFields>
      <DataField>
        <Name>test_text</Name>
        <Type>Text</Type>
        <Value>foobar</Value>
      </DataField>
      <DataField>
        <Name>test_number</Name>
        <Type>Number</Type>
        <Value>123</Value>
      </DataField>
      <DataField>
        <Name>test_date</Name>
        <Type>Date</Type>
        <Value>2015-01-23</Value>
      </DataField>
      <DataField>
        <Name>test_datetime</Name>
        <Type>Datetime</Type>
        <Value>2015-01-23 12:34:56</Value>
      </DataField>
      <DataField>
        <Name>test_boolean</Name>
        <Type>Boolean</Type>
        <Value>false</Value>
      </DataField>
    </DataFields>
  </Data>
</ApiRequest>

Методы API - меню