Create/Add change to a change request

POST 
<your-unleash-url>/api/admin/projects/:projectId/environments/:environment/change-requests

Given a change request exists, this endpoint will attempt to add a change to an existing change request for the user. If a change request does not exist, it will attempt to create one.

Request

Path Parameters

projectId stringrequired
environment stringrequired

application/json

Bodyrequired

changeRequestOneOrManyCreateSchema

oneOf
MOD1
actionstringrequired
The name of this action.
Possible values: [updateSegment]
payload objectrequired
Data used to create or update a segment
idintegerrequired
The ID of the segment to update.
Example: 1
MOD2
actionstringrequired
The name of this action.
Possible values: [deleteSegment]
payload objectrequired
Required data to delete a segment.
idintegerrequired
The ID of the segment to delete.
Example: 1
MOD3
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [updateEnabled]
payload objectrequired
enabledbooleanrequired
The new state of the feature.
Example: true
shouldActivateDisabledStrategiesboolean
Only relevant when ALL the strategies are disabled. If true, all the disabled strategies will be enabled. If false, the default strategy will be added
Example: true
MOD4
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [addStrategy]
payload objectrequired
Create a strategy configuration in a feature
namestringrequired
The name of the strategy type
Example: flexibleRollout
titlestringnullable
A descriptive title for the strategy
Example: Gradual Rollout 25-Prod
disabledbooleannullable
A toggle to disable the strategy. defaults to false. Disabled strategies are not evaluated or returned to the SDKs
Example: false
sortOrdernumber
The order of the strategy in the list
Example: 9999
constraints object[]required
A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/activation-strategies#constraints
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
]
variants object[]
Strategy level variants
Array [
namestringrequired
The variant name. Must be unique for this feature flag
Example: blue_group
weightintegerrequired
The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on variant weights for more information
Possible values: <= 1000
weightTypestringrequired
Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the variant weight documentation.
Possible values: [variable, fix]
Example: fix
stickinessstringrequired
The stickiness to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time
Example: custom.context.field
payload object
Extra data configured for this variant
typestringrequired
The type of the value. Commonly used types are string, number, json and csv.
Possible values: [json, csv, string, number]
valuestringrequired
The actual value of payload
]
parameters objectrequired
A list of parameters for a strategy
property name*string
segmentsnumber[]
Ids of segments to use for this strategy
Example: [1,2]
MOD5
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [updateStrategy]
payload objectrequired
Update a strategy configuration in a feature
idstringrequired
The ID of the strategy to update.
Example: 0103487d-8788-4cda-af59-0a68642dbc5a
MOD6
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [deleteStrategy]
payload objectrequired
idstringrequired
The ID of the strategy to update.
Example: 0103487d-8788-4cda-af59-0a68642dbc5a
MOD7
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [archiveFeature]
MOD8
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [patchVariant]
payload objectrequired
variants object[]required
Array [
namestringrequired
The variants name. Is unique for this feature flag
Example: blue_group
weightnumberrequired
The weight is the likelihood of any one user getting this variant. It is a number between 0 and 1000. See the section on variant weights for more information
Possible values: <= 1000
weightTypestring
Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000
Possible values: [variable, fix]
Example: variable
stickinessstring
Stickiness is how Unleash guarantees that the same user gets the same variant every time
Example: custom.context.field
payload object
Extra data configured for this variant
typestringrequired
The type of the value. Commonly used types are string, number, json and csv.
Possible values: [json, csv, string, number]
valuestringrequired
The actual value of payload
overrides object[]
Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence.
Array [
contextNamestringrequired
The name of the context field used to determine overrides
Example: userId
valuesstring[]required
Which values that should be overriden
Example: ["red","blue"]
]
]
MOD9
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [reorderStrategy]
payload object[]required
An array of strategies with their new sort order
Array [
idstringrequired
The ID of the strategy
Example: 9c40958a-daac-400e-98fb-3bb438567008
sortOrdernumberrequired
The new sort order of the strategy
Example: 1
]
MOD10
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [addDependency]
payload objectrequired
Feature dependency on a parent feature in write model
featurestringrequired
The name of the feature we depend on.
Example: parent_feature
enabledboolean
Whether the parent feature should be enabled. When false variants are ignored. true by default.
Example: false
variantsstring[]
The list of variants the parent feature should resolve to. Leave empty when you only want to check the enabled status.
Example: ["variantA","variantB"]
MOD11
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [deleteDependency]
MOD12
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [addReleasePlan]
payload objectrequired
Schema for creating a release plan for a feature flag environment by copying and applying the configuration from a release plan template.
templateIdstringrequired
The release plan template's ID. Release template IDs are ulids.
Example: 01JB9GGTGQYEQ9D40R17T3YVW2
MOD13
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [startMilestone]
payload objectrequired
The ID of the release plan and which of its milestones to start.
milestoneIdstringrequired
The ID of the milestone to start. This ID is an ulid
Example: 01JB9GGTGQYEQ9D40R17T3YVW3
planIdstringrequired
The ID of the release plan. This ID is an ulid
Example: 01JB9GGTGQYEQ9D40R17T3YVW3
MOD14
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [deleteReleasePlan]
payload objectrequired
The Id of the release plan to remove.
planIdstringrequired
The Id of the release plan. This id is an ulid
Example: 01JB9GGTGQYEQ9D40R17T3YVW3
MOD15
Array [
oneOf
MOD1
actionstringrequired
The name of this action.
Possible values: [updateSegment]
payload objectrequired
Data used to create or update a segment
idintegerrequired
The ID of the segment to update.
Example: 1
MOD2
actionstringrequired
The name of this action.
Possible values: [deleteSegment]
payload objectrequired
Required data to delete a segment.
idintegerrequired
The ID of the segment to delete.
Example: 1
MOD3
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [updateEnabled]
payload objectrequired
enabledbooleanrequired
The new state of the feature.
Example: true
shouldActivateDisabledStrategiesboolean
Only relevant when ALL the strategies are disabled. If true, all the disabled strategies will be enabled. If false, the default strategy will be added
Example: true
MOD4
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [addStrategy]
payload objectrequired
Create a strategy configuration in a feature
namestringrequired
The name of the strategy type
Example: flexibleRollout
titlestringnullable
A descriptive title for the strategy
Example: Gradual Rollout 25-Prod
disabledbooleannullable
A toggle to disable the strategy. defaults to false. Disabled strategies are not evaluated or returned to the SDKs
Example: false
sortOrdernumber
The order of the strategy in the list
Example: 9999
constraints object[]required
A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/activation-strategies#constraints
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
]
variants object[]
Strategy level variants
Array [
namestringrequired
The variant name. Must be unique for this feature flag
Example: blue_group
weightintegerrequired
The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on variant weights for more information
Possible values: <= 1000
weightTypestringrequired
Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the variant weight documentation.
Possible values: [variable, fix]
Example: fix
stickinessstringrequired
The stickiness to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time
Example: custom.context.field
payload object
Extra data configured for this variant
typestringrequired
The type of the value. Commonly used types are string, number, json and csv.
Possible values: [json, csv, string, number]
valuestringrequired
The actual value of payload
]
parameters objectrequired
A list of parameters for a strategy
property name*string
segmentsnumber[]
Ids of segments to use for this strategy
Example: [1,2]
MOD5
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [updateStrategy]
payload objectrequired
Update a strategy configuration in a feature
idstringrequired
The ID of the strategy to update.
Example: 0103487d-8788-4cda-af59-0a68642dbc5a
MOD6
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [deleteStrategy]
payload objectrequired
idstringrequired
The ID of the strategy to update.
Example: 0103487d-8788-4cda-af59-0a68642dbc5a
MOD7
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [archiveFeature]
MOD8
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [patchVariant]
payload objectrequired
variants object[]required
Array [
namestringrequired
The variants name. Is unique for this feature flag
Example: blue_group
weightnumberrequired
The weight is the likelihood of any one user getting this variant. It is a number between 0 and 1000. See the section on variant weights for more information
Possible values: <= 1000
weightTypestring
Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000
Possible values: [variable, fix]
Example: variable
stickinessstring
Stickiness is how Unleash guarantees that the same user gets the same variant every time
Example: custom.context.field
payload object
Extra data configured for this variant
typestringrequired
The type of the value. Commonly used types are string, number, json and csv.
Possible values: [json, csv, string, number]
valuestringrequired
The actual value of payload
overrides object[]
Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence.
Array [
contextNamestringrequired
The name of the context field used to determine overrides
Example: userId
valuesstring[]required
Which values that should be overriden
Example: ["red","blue"]
]
]
MOD9
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [reorderStrategy]
payload object[]required
An array of strategies with their new sort order
Array [
idstringrequired
The ID of the strategy
Example: 9c40958a-daac-400e-98fb-3bb438567008
sortOrdernumberrequired
The new sort order of the strategy
Example: 1
]
MOD10
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [addDependency]
payload objectrequired
Feature dependency on a parent feature in write model
featurestringrequired
The name of the feature we depend on.
Example: parent_feature
enabledboolean
Whether the parent feature should be enabled. When false variants are ignored. true by default.
Example: false
variantsstring[]
The list of variants the parent feature should resolve to. Leave empty when you only want to check the enabled status.
Example: ["variantA","variantB"]
MOD11
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [deleteDependency]
MOD12
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [addReleasePlan]
payload objectrequired
Schema for creating a release plan for a feature flag environment by copying and applying the configuration from a release plan template.
templateIdstringrequired
The release plan template's ID. Release template IDs are ulids.
Example: 01JB9GGTGQYEQ9D40R17T3YVW2
MOD13
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [startMilestone]
payload objectrequired
The ID of the release plan and which of its milestones to start.
milestoneIdstringrequired
The ID of the milestone to start. This ID is an ulid
Example: 01JB9GGTGQYEQ9D40R17T3YVW3
planIdstringrequired
The ID of the release plan. This ID is an ulid
Example: 01JB9GGTGQYEQ9D40R17T3YVW3
MOD14
featurestringrequired
The name of the feature that this change applies to.
Example: my-best-feature
actionstringrequired
The name of this action.
Possible values: [deleteReleasePlan]
payload objectrequired
The Id of the release plan to remove.
planIdstringrequired
The Id of the release plan. This id is an ulid
Example: 01JB9GGTGQYEQ9D40R17T3YVW3
]

Responses

200

changeRequestSchema

application/json

Schema

Schema

oneOf
MOD1
MOD2

Example (auto)

{
  "id": 3,
  "title": "Increasing gradual rollout",
  "environment": "development",
  "minApprovals": 2,
  "project": "unleash-project",
  "features": [
    {
      "name": "my-feature",
      "conflict": "Feature has been archived",
      "changes": [
        {
          "id": 33,
          "action": "updateStrategy",
          "conflict": "Strategy has been deleted",
          "payload": "string",
          "createdBy": {
            "username": "string",
            "imageUrl": "string"
          },
          "createdAt": "2023-07-31T13:22:03+02:00"
        }
      ],
      "defaultChange": {
        "action": "addStrategy",
        "payload": {
          "name": "flexibleRollout",
          "title": "",
          "disabled": false,
          "segments": [],
          "parameters": {
            "groupId": "my-feature",
            "rollout": "100",
            "stickiness": "default"
          },
          "constraints": [
            {
              "values": [
                "ux"
              ],
              "inverted": false,
              "operator": "STR_CONTAINS",
              "contextName": "userId",
              "caseInsensitive": false
            }
          ]
        }
      }
    }
  ],
  "segments": [
    {
      "id": 33,
      "action": "updateStrategy",
      "conflict": "Strategy has been deleted",
      "payload": "string",
      "createdBy": {
        "username": "string",
        "imageUrl": "string"
      },
      "createdAt": "2023-07-31T13:22:03+02:00",
      "name": "beta-users"
    }
  ],
  "approvals": [
    {
      "createdBy": {
        "id": 33,
        "username": "unleash-user",
        "imageUrl": "string"
      },
      "createdAt": "2022-12-12T12:13:24.218Z"
    }
  ],
  "rejections": [
    {
      "createdBy": {
        "id": 33,
        "username": "unleash-user",
        "imageUrl": "string"
      },
      "createdAt": "2022-12-12T12:13:24.218Z"
    }
  ],
  "comments": [
    {
      "id": 33,
      "text": "This is a comment",
      "createdBy": {
        "username": "unleash-user",
        "imageUrl": "string"
      },
      "createdAt": "2022-12-12T12:13:24.218Z"
    }
  ],
  "createdBy": {
    "username": "Hunter",
    "imageUrl": "string"
  },
  "createdAt": "2023-07-31T13:33:02Z",
  "state": "Draft"
}

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 '<your-unleash-url>/api/admin/projects/:projectId/environments/:environment/change-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
-d '{
  "action": "updateSegment",
  "payload": {
    "id": 1
  }
}'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

projectId — pathrequired

environment — pathrequired

Body required

{
  "action": "updateSegment",
  "payload": {
    "id": 1
  }
}

ResponseClear

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