Update a segment

Updates the specified segment by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/segments/{id}
JWT
segment:write

Parameters

NameTypeInDescription
id*stringpathUnique identifier for the segment.

Request Body Schema

PropertyTypeDescriptionConstraints
namestringName of the segment.min: 1, max: 256
resourcestringName of the resource.
filtersarrayFilter for the segment.items: object
property*stringName of the property.min: 1, max: 256
operator*stringName of the operator.min: 1, max: 256
value*stringValue of the property.min: 1, max: 256

Request Example

{
  "name": "string",
  "resource": "string",
  "filters": [
    {
      "property": "string",
      "operator": "string",
      "value": "string"
    }
  ]
}

Responses

200 OK
{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "resource": "string",
  "filters": [
    {
      "property": "string",
      "operator": "string",
      "value": "string"
    }
  ]
}