Segments

Update segment by id

Changed on

Updates the content of the segment with the provided payload. Requires name and constraints to be present. If project is not present, it will be set to null. Any other fields not specified will be left untouched.

put/api/admin/segments/{id}

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/segments/{id}
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

idinteger required

a segment id

Request body

namestring required

The name of the segment

descriptionstring nullable

A description of what the segment is for

projectstring nullable

The project the segment belongs to if any.

Example request

{
  "name": "beta-users",
  "description": "Users willing to help us test and build new features.",
  "project": "red-vista",
  "constraints": [
    {
      "contextName": "appName",
      "operator": "IN",
      "values": [
        "my-app",
        "my-other-app"
      ],
      "value": "my-app"
    }
  ]
}

Response

This response has no body.

Changes

  • b2c3116e633eRevision changes
    • breaking

      the // request property's minLength was increased from 0 to 1

    • info

      added the new SEMVER_GTE enum value to the request property //

    • info

      added the new SEMVER_LTE enum value to the request property //

  • 774670258f04Revision changes
    • info

      added the new REGEX enum value to the request property //