v1

latestOpenAPI 3.0.12026-07-2471135326.0 KB

Segments

Edit Segment

This endpoint helps you to <b>partially<b> update an existing segment from a list identified by its unique ID (it edits only the fields sent in the request).

patch/v3/lists/{listId}/segments/{segmentId}

Path parameters

listIdinteger required

Provide the unique ID of the list

segmentIdstring required

Provide the unique ID of the segment

Request body

string required

Response

Successfully edited the segment

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  },
  "data": {
    "id": "507f1f77bcf86cd799439011",
    "name": "people who likes movies",
    "userName": "homer",
    "listId": 203,
    "queryRule": "movies[eq]=horror&age[gt]=21",
    "total": 7
  }
}