Create segment

Description

Creates a new segment.

Request URL

Method: POST

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

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"json"	No	Response data format. By default – json
name	string	"New segment"	Yes	New segment name
segment	JSON array		Yes

Request example

{
    "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"
}

Response example

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

Response parameters

Parameter	Type	Description
error	int	Код ошибки
error_text	string	Текст ошибки
saved_id	int	New segment ID