Update segment by id

PUT 
<your-unleash-url>/api/admin/segments/:id

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.

Request

Path Parameters

id integerrequired

a segment id

application/json

Bodyrequired

upsertSegmentSchema

namestringrequired
The name of the segment
Example: beta-users
descriptionstringnullable
A description of what the segment is for
Example: Users willing to help us test and build new features.
projectstringnullable
The project the segment belongs to if any.
Example: red-vista
constraints object[]required
The list of constraints that make up this segment
Array [
contextNamestringrequired
The name of the context field that this constraint should apply to.
Example: appName
operatorstringrequired
The operator to use when evaluating this constraint. For more information about the various operators, refer to the strategy constraint operator documentation.
Possible values: [NOT_IN, IN, STR_ENDS_WITH, STR_STARTS_WITH, STR_CONTAINS, NUM_EQ, NUM_GT, NUM_GTE, NUM_LT, NUM_LTE, DATE_AFTER, DATE_BEFORE, SEMVER_EQ, SEMVER_GT, SEMVER_LT]
Example: IN
caseInsensitiveboolean
Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).
Default value: false
invertedboolean
Whether the result should be negated or not. If true, will turn a true result into a false result and vice versa.
Default value: false
valuesstring[]
The context values that should be used for constraint evaluation. Use this property instead of value for properties that accept multiple values.
Example: ["my-app","my-other-app"]
valuestring
The context value that should be used for constraint evaluation. Use this property instead of values for properties that only accept single values.
Example: my-app
]

Responses

204

This response has no body.

400

The request data does not match what we expect.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: ValidationError
messagestring
A description of what went wrong.
Example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NoAccessError
messagestring
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

409

The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NameExistsError
messagestring
A description of what went wrong.
Example: There is already a feature called "my-awesome-feature".

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NameExistsError",
  "message": "There is already a feature called \"my-awesome-feature\"."
}

415

The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: ContentTypeerror
messagestring
A description of what went wrong.
Example: We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ContentTypeerror",
  "message": "We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format."
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT '<your-unleash-url>/api/admin/segments/:id' \
-H 'Content-Type: application/json' \
-H 'Authorization: <Authorization>' \
-d '{
  "name": "beta-users",
  "description": "Users willing to help us test and build new features.",
  "project": "red-vista",
  "constraints": [
    {
      "contextName": "appName",
      "operator": "IN",
      "caseInsensitive": false,
      "inverted": false,
      "values": [
        "my-app",
        "my-other-app"
      ],
      "value": "my-app"
    }
  ]
}'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

id — pathrequired

Body required

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

ResponseClear

Click the Send API Request button above and see the response here!