Обновить сегмент

Описание

Изменить правила построения сегмента.

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API-токен
format	string	"json"	Да	Формат возвращаемых данных (по умолчанию – "json")
list_id	int	5	Да, для статических сегментов	Идентификатор базы данных, из которой будут взяты профили
id	int	1	Да	Идентификатор сегмента
name	string	"New segment"	Да	Название сегмента
segment	JSON array		Да, для динамических и обновляемых сегментов	Условия сегментации. Массив должен содержать хотя бы один объект. Не используется для статических сегментов.

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

подсказка

При обновлении условий сегментации заданную базу профилей изменить невозможно.

Для статического сегмента

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz"
    "id": 2,
    "list_id":5
    "name": "Static segment 2",
    "is_static": true,
    "is_refresh_daily": false
}

XML

<xml>
  <id>2</id>
  <list_id>5</list_id>
  <name>New segment 2</name>
  <is_static>true</is_static>
  <is_refresh_daily>false</is_refresh_daily>
  <token>abcdefghijklmnqrstuvwxyz</token>
</xml>

Для динамического сегмента

При изменении правил построения динамического сегмента наличие правил сегментации в поле segment обязательно.

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "id": 14,
    "list_id": 6,
    "name": "Static segment 2",
    "is_static": false,
    "segment": [
        {
            "condition": "and",
            "limit": 0,
            "percent_from": 1,
            "list_id": 6,
            "percent_to": 99,
            "queries": [
                {
                    "compo": "domaingroup",
                    "name": "email",
                    "operator": "equal",
                    "type": "email",
                    "value": [
                        {
                            "name": "domaingroup",
                            "value": "Yahoo! (US)"
                        }
                    ]
                }
            ]
        }
    ]
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <id>14</id>
  <name>New segment 2</name>
  <is_static>false</is_static>
  <segment array="">
    <list_id>6</list_id>
    <condition>and</condition>
    <limit>0</limit>
    <percent_from>0</percent_from>
    <percent_to>99</percent_to>
    <queries array="">
      <compo>domaingroup</compo>
      <name>email</name>
      <operator>equal</operator>
      <type>email</type>
      <value array="">
        <name>domaingroup</name>
        <value>Yahoo! (US)</value>
      </value>
    </queries>
  </segment>
</xml>

Для обновляемого сегмента

При изменении правил построения обновляемого сегмента наличие правил сегментации в поле segment обязательно.

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "id": 28,
    "list_id": 6,
    "name": "Static segment 2",
    "is_static": true,
    "is_refresh_daily": true,
    "segment": [
        {
            "condition": "and",
            "limit": 0,
            "percent_from": 1,
            "list_id": 6,
            "percent_to": 99,
            "queries": [
                {
                    "compo": "domaingroup",
                    "name": "email",
                    "operator": "equal",
                    "type": "email",
                    "value": [
                        {
                            "name": "domaingroup",
                            "value": "Yahoo! (US)"
                        }
                    ]
                }
            ]
        }
    ]
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <id>28</id>
  <name>New segment 2</name>
  <is_static>true</is_static>
  <is_refresh_daily>true</is_refresh_daily>
  <segment array="">
    <list_id>6</list_id>
    <condition>and</condition>
    <limit>0</limit>
    <percent_from>0</percent_from>
    <percent_to>99</percent_to>
    <queries array="">
      <compo>domaingroup</compo>
      <name>email</name>
      <operator>equal</operator>
      <type>email</type>
      <value array="">
        <name>domaingroup</name>
        <value>Yahoo! (US)</value>
      </value>
    </queries>
  </segment>
</xml>

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

JSON

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

XML

<xml>
    <data>
        <saved_id>14</saved_id>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

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

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