Skip to main content

Update segment

Description

Updates segment details.

Request URL

Method: POST

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

Request parameters

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
formatstring"json"YesResponse data format.
By default – json
idint1YesSegment ID
namestring"New segment"YesSegment name
segmentJSON array
YesQueries to update

Request example

{
"id": 1,
"name": "New segment",
"segment": [
{
"condition": "or",
"limit": 0,
"list_id": 1,
"percent_from": 0,
"percent_to": 99,
"queries": [
{
"child": [],
"compo": "default",
"condition": "",
"name": "custom_tags",
"operator": "all",
"type": "tags",
"value": [
{
"name": "default",
"value": [
"TAG_A",
"TAG_B",
"TAG_C",
"TAG_D"
]
}
]
}
]
}
],
"token": "abcdefghijklmnqrstuvwxyz"
}

Response example

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

Response parameters

ParameterTypeDescription
errorintError code
error_textstringError text
saved_idintSegment ID