Documentation Index

Fetch the complete documentation index at: https://docs.xtremepush.com/llms.txt

Use this file to discover all available pages before exploring further.

Update segment

Prev Next
Post
/update/segment

Used to update an existing segment.

For more information on segments review our segmentation guide. For details on the available conditions for this endpoint see our dedicated segment model properties guide.

Body parameters
object
apptoken
string Required

Your App token

id
integer (int32) Required

ID of the segment

title
string

Updated title of the segment

condition
string (json)

Updated conditions for the segment

Responses
200

200

Result
{
  "success": "True",
  "code": "200",
  "message": "Segment is successfully updated",
  "model": {
    "id": "SEGMENT_ID",
    "project_id": "PROJECT_ID",
    "title": "Email subscribed",
    "conditions": {
      "0": {
        "0": [
          "email_subscription",
          "=",
          "0"
        ],
        "operator": "AND"
      },
      "operator": "AND"
    }
  }
}
Expand All
object
success
boolean
Defaulttrue
ExampleTrue
code
integer
Default0
Example200
message
string
ExampleSegment is successfully updated
model
object
id
string
ExampleSEGMENT_ID
project_id
string
ExamplePROJECT_ID
title
string
ExampleEmail subscribed
conditions
object
400

400

Result
{
  "success": "False",
  "code": "400",
  "message": "General error information"
}
Expand All
object
success
boolean
Defaulttrue
ExampleFalse
code
integer
Default0
Example400
message
string
ExampleGeneral error information
errors
Array of object
object
text
Array of string
string
404

404

Result
{
  "success": "False",
  "code": "404",
  "message": "Not Found"
}
object
success
boolean
Defaulttrue
ExampleFalse
code
integer
Default0
Example404
message
string
ExampleNot Found