Добавить сегмент

Описание

Добавить новый сегмент.

URL-адрес

Метод: POST

https://example.com/api/v1.1/segments/add/

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	string	"json"	Нет	Формат возвращаемых данных (по умолчанию – "json")
name	string	"New segment"	Да	Название сегмента
segment	JSON array		Да

Пример запроса

JSON

{
  "name": "New segment",
  "segment": [
    {
      "condition": "or",
      "limit": 0,
      "list_id": 1,
      "percent_from": 0,
      "percent_to": 99,
      "queries": [
        {
          "child": [],
          "compo": "dataurl",
          "condition": "",
          "name": "subscription_email",
          "operator": "in_data",
          "type": "subscription_email",
          "value": [
            {
              "name": "field",
              "value": "subscriptions"
            },
            {
              "name": "resource_id",
              "value": 1
            },
            {
              "name": "url",
              "value": "http://127.0.0.1:8080/json.email.subscriptions"
            }
          ]
        }
      ]
    }
  ],
  "token": "abcdefghijklmnqrstuvwxyz"
}

XML

<?xml version="1.0" encoding="UTF-8" ?>
<xml>
  <name>New segment</name>
  <segment>
    <condition>or</condition>
    <limit>0</limit>
    <list_id>1</list_id>
    <percent_from>0</percent_from>
    <percent_to>99</percent_to>
    <queries>
      <child/>
      <compo>dataurl</compo>
      <condition>
      </condition>
      <name>subscription_email</name>
      <operator>in_data</operator>
      <type>subscription_email</type>
      <value>
        <name>field</name>
        <value>subscriptions</value>
      </value>
      <value>
        <name>resource_id</name>
        <value>1</value>
      </value>
      <value>
        <name>url</name>
        <value>http://127.0.0.1:8080/json.email.subscriptions</value>
      </value>
    </queries>
  </segment>
  <token>abcdefghijklmnqrstuvwxyz</token>
</xml>

Пример ответа

JSON

{
  "data": {
    "saved_id": 1
  },
  "error": 0,
  "error_text": "Successful operation"
}

XML

<?xml version="1.0" encoding="UTF-8" ?>
<xml>
  <data>
    <saved_id>1</saved_id>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
saved_id	int	Идентификатор нового сегмента