Create/Add change to a change request

POST 
/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 it.

Request

Path Parameters

projectId stringrequired
environment stringrequired

application/json

Body

required

changeRequestOneOrManyCreateSchema

oneOf

MOD1

action stringrequired

The name of this action.

Possible values: [updateSegment]

payload

object

required

Data used to create or update a segment

id integerrequired

The ID of the segment to update.

Example: 1

MOD2

action stringrequired

The name of this action.

Possible values: [deleteSegment]

payload

object

required

Required data to delete a segment.

id integerrequired

The ID of the segment to delete.

Example: 1

MOD3

Update the enabled state for a feature.

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [updateEnabled]

payload

object

required

enabled booleanrequired

The new state of the feature.

Example: true

shouldActivateDisabledStrategies boolean

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

Add a strategy to the feature

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [addStrategy]

payload

object

required

Create a strategy configuration in a feature

name stringrequired

The name of the strategy type

Example: flexibleRollout

title stringnullable

A descriptive title for the strategy

Example: Gradual Rollout 25-Prod

disabled booleannullable

A toggle to disable the strategy. defaults to false. Disabled strategies are not evaluated or returned to the SDKs

Example: false

sortOrder number

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/strategy-constraints

Array [

contextName stringrequired

The name of the context field that this constraint should apply to.

Example: appName

operator stringrequired

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

caseInsensitive boolean

Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).

Default value: false

inverted boolean

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

values string[]

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"]

value string

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 [

name stringrequired

The variant name. Must be unique for this feature flag

Example: blue_group

weight integerrequired

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

weightType stringrequired

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

stickiness stringrequired

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

type stringrequired

The type of the value. Commonly used types are string, number, json and csv.

Possible values: [json, csv, string, number]

value stringrequired

The actual value of payload

]

parameters

object

required

A list of parameters for a strategy

property name* string

segments number[]

Ids of segments to use for this strategy

Example: [1,2]

MOD5

Update a strategy belonging to this feature.

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [updateStrategy]

payload

object

required

Update a strategy configuration in a feature

id stringrequired

The ID of the strategy to update.

Example: 0103487d-8788-4cda-af59-0a68642dbc5a

MOD6

Delete a strategy from this feature.

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [deleteStrategy]

payload

object

required

id stringrequired

The ID of the strategy to update.

Example: 0103487d-8788-4cda-af59-0a68642dbc5a

MOD7

Archive a feature.

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [archiveFeature]

MOD8

Update variants for this feature.

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [patchVariant]

payload

object

required

variants

object[]

required

Array [

name stringrequired

The variants name. Is unique for this feature flag

Example: blue_group

weight numberrequired

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

weightType string

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

stickiness string

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

type stringrequired

The type of the value. Commonly used types are string, number, json and csv.

Possible values: [json, csv, string, number]

value stringrequired

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 [

contextName stringrequired

The name of the context field used to determine overrides

Example: userId

values string[]required

Which values that should be overriden

Example: ["red","blue"]

]

]

MOD9

Reorder strategies for this feature

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [reorderStrategy]

payload

object[]

required

An array of strategies with their new sort order

Array [

id stringrequired

The ID of the strategy

Example: 9c40958a-daac-400e-98fb-3bb438567008

sortOrder numberrequired

The new sort order of the strategy

Example: 1

]

MOD10

Add a parent feature dependency.

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [addDependency]

payload

object

required

Feature dependency on a parent feature in write model

feature stringrequired

The name of the feature we depend on.

Example: parent_feature

enabled boolean

Whether the parent feature should be enabled. When false variants are ignored. true by default.

Example: false

variants string[]

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

Remove a parent feature dependency or all dependencies if no payload.

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [deleteDependency]

MOD12

Array [

oneOf

MOD1

action stringrequired

The name of this action.

Possible values: [updateSegment]

payload

object

required

Data used to create or update a segment

id integerrequired

The ID of the segment to update.

Example: 1

MOD2

action stringrequired

The name of this action.

Possible values: [deleteSegment]

payload

object

required

Required data to delete a segment.

id integerrequired

The ID of the segment to delete.

Example: 1

MOD3

Update the enabled state for a feature.

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [updateEnabled]

payload

object

required

enabled booleanrequired

The new state of the feature.

Example: true

shouldActivateDisabledStrategies boolean

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

Add a strategy to the feature

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [addStrategy]

payload

object

required

Create a strategy configuration in a feature

name stringrequired

The name of the strategy type

Example: flexibleRollout

title stringnullable

A descriptive title for the strategy

Example: Gradual Rollout 25-Prod

disabled booleannullable

A toggle to disable the strategy. defaults to false. Disabled strategies are not evaluated or returned to the SDKs

Example: false

sortOrder number

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/strategy-constraints

Array [

contextName stringrequired

The name of the context field that this constraint should apply to.

Example: appName

operator stringrequired

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

caseInsensitive boolean

Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).

Default value: false

inverted boolean

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

values string[]

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"]

value string

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 [

name stringrequired

The variant name. Must be unique for this feature flag

Example: blue_group

weight integerrequired

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

weightType stringrequired

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

stickiness stringrequired

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

type stringrequired

The type of the value. Commonly used types are string, number, json and csv.

Possible values: [json, csv, string, number]

value stringrequired

The actual value of payload

]

parameters

object

required

A list of parameters for a strategy

property name* string

segments number[]

Ids of segments to use for this strategy

Example: [1,2]

MOD5

Update a strategy belonging to this feature.

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [updateStrategy]

payload

object

required

Update a strategy configuration in a feature

id stringrequired

The ID of the strategy to update.

Example: 0103487d-8788-4cda-af59-0a68642dbc5a

MOD6

Delete a strategy from this feature.

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [deleteStrategy]

payload

object

required

id stringrequired

The ID of the strategy to update.

Example: 0103487d-8788-4cda-af59-0a68642dbc5a

MOD7

Archive a feature.

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [archiveFeature]

MOD8

Update variants for this feature.

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [patchVariant]

payload

object

required

variants

object[]

required

Array [

name stringrequired

The variants name. Is unique for this feature flag

Example: blue_group

weight numberrequired

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

weightType string

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

stickiness string

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

type stringrequired

The type of the value. Commonly used types are string, number, json and csv.

Possible values: [json, csv, string, number]

value stringrequired

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 [

contextName stringrequired

The name of the context field used to determine overrides

Example: userId

values string[]required

Which values that should be overriden

Example: ["red","blue"]

]

]

MOD9

Reorder strategies for this feature

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [reorderStrategy]

payload

object[]

required

An array of strategies with their new sort order

Array [

id stringrequired

The ID of the strategy

Example: 9c40958a-daac-400e-98fb-3bb438567008

sortOrder numberrequired

The new sort order of the strategy

Example: 1

]

MOD10

Add a parent feature dependency.

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [addDependency]

payload

object

required

Feature dependency on a parent feature in write model

feature stringrequired

The name of the feature we depend on.

Example: parent_feature

enabled boolean

Whether the parent feature should be enabled. When false variants are ignored. true by default.

Example: false

variants string[]

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

Remove a parent feature dependency or all dependencies if no payload.

feature stringrequired

The name of the feature that this change applies to.

Example: my-best-feature

action stringrequired

The name of this action.

Possible values: [deleteDependency]

]

Responses

200

changeRequestSchema

application/json

Schema

Schema

oneOf

MOD1

id numberrequired

This change requests's ID.

Example: 3

title string

A title describing the change request's content.

Example: Increasing gradual rollout

environment stringrequired

The environment in which the changes should be applied.

Example: development

minApprovals numberrequired

The minimum number of approvals required before this change request can be applied.

Example: 2

project stringrequired

The project this change request belongs to.

Example: unleash-project

features

object[]

required

The list of features and their changes that relate to this change request.

Array [

name stringrequired

The name of the feature

Example: my-feature

conflict string

A string describing the conflicts related to this change. Only present if there are any concflicts on the feature level.

Example: Feature has been archived

changes

object[]

required

List of changes inside change request. This list may be empty when listing all change requests for a project.

Array [

id numberrequired

The ID of this change.

Example: 33

action stringrequired

The kind of action that the change contains information about.

Example: updateStrategy

conflict string

A description of the conflict caused by this change. Only present if there are any conflicts.

Example: Strategy has been deleted

payload

object

required

The data required to perform this action.

oneOf

MOD1

string

MOD2

boolean

MOD3

object

MOD4

number

setStrategySortOrderSchema

An array of strategies with their new sort order

Array [

id stringrequired

The ID of the strategy

Example: 9c40958a-daac-400e-98fb-3bb438567008

sortOrder numberrequired

The new sort order of the strategy

Example: 1

]

createdBy

object

The user who created this change.

username stringnullable

The user's username.

imageUrl urinullable

The URL where the user's image can be found.

createdAt date-time

When this change was suggested

Example: 2023-07-31T13:22:03+02:00

]

defaultChange

object

A description of a default change that will be applied with the change request to prevent invalid states.

Default changes are changes that are applied in addition to explicit user-specified changes when a change request is applied. Any default changes are applied in the background and are not a real part of the change request.

action stringrequired

The kind of action this is.

Example: addStrategy

payload objectrequired

The necessary data to perform this change.

Example: {"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

object[]

required

The list of segments and their changes that relate to this change request.

Array [

id numberrequired

The ID of this change.

Example: 33

action stringrequired

The kind of action that the change contains information about.

Example: updateStrategy

conflict string

A description of the conflict caused by this change. Only present if there are any conflicts.

Example: Strategy has been deleted

payload

object

required

The data required to perform this action.

oneOf

MOD1

string

MOD2

boolean

MOD3

object

MOD4

number

setStrategySortOrderSchema

An array of strategies with their new sort order

Array [

id stringrequired

The ID of the strategy

Example: 9c40958a-daac-400e-98fb-3bb438567008

sortOrder numberrequired

The new sort order of the strategy

Example: 1

]

createdBy

object

The user who created this change.

username stringnullable

The user's username.

imageUrl urinullable

The URL where the user's image can be found.

createdAt date-time

When this change was suggested

Example: 2023-07-31T13:22:03+02:00

name stringrequired

The current name of the segment

Example: beta-users

]

approvals

object[]

A list of approvals that this change request has received.

Array [

createdBy

object

required

Information about the user who gave this approval.

id number

The ID of the user who gave this approval.

Example: 33

username string

The approving user's username.

Example: unleash-user

imageUrl uri

The URL where the user's image can be found.

createdAt date-timerequired

When the approval was given.

Example: 2022-12-12T12:13:24.218Z

]

rejections

object[]

A list of rejections that this change request has received.

Array [

createdBy

object

required

Information about the user who gave this approval.

id number

The ID of the user who gave this approval.

Example: 33

username string

The approving user's username.

Example: unleash-user

imageUrl uri

The URL where the user's image can be found.

createdAt date-timerequired

When the approval was given.

Example: 2022-12-12T12:13:24.218Z

]

comments

object[]

All comments that have been made on this change request.

Array [

id number

The comment's ID. Unique per change request.

Example: 33

text stringrequired

The content of the comment.

Example: This is a comment

createdBy

object

required

Information about the user who posted the comment

username stringnullable

The user's username.

Example: unleash-user

imageUrl urinullable

The URL where the user's image can be found.

createdAt date-timerequired

When the comment was made.

Example: 2022-12-12T12:13:24.218Z

]

createdBy

object

required

The user who created this change request.

username stringnullable

Example: Hunter

imageUrl urinullable

The URL of the user's profile image.

createdAt date-timerequired

When this change request was created.

Example: 2023-07-31T13:33:02Z

state stringrequired

The current state of the change request.

Possible values: [Draft, In review, Approved, Applied, Cancelled, Rejected]

MOD2

id numberrequired

This change requests's ID.

Example: 3

title string

A title describing the change request's content.

Example: Increasing gradual rollout

environment stringrequired

The environment in which the changes should be applied.

Example: development

minApprovals numberrequired

The minimum number of approvals required before this change request can be applied.

Example: 2

project stringrequired

The project this change request belongs to.

Example: unleash-project

features

object[]

required

The list of features and their changes that relate to this change request.

Array [

name stringrequired

The name of the feature

Example: my-feature

conflict string

A string describing the conflicts related to this change. Only present if there are any concflicts on the feature level.

Example: Feature has been archived

changes

object[]

required

List of changes inside change request. This list may be empty when listing all change requests for a project.

Array [

id numberrequired

The ID of this change.

Example: 33

action stringrequired

The kind of action that the change contains information about.

Example: updateStrategy

conflict string

A description of the conflict caused by this change. Only present if there are any conflicts.

Example: Strategy has been deleted

payload

object

required

The data required to perform this action.

oneOf

MOD1

string

MOD2

boolean

MOD3

object

MOD4

number

setStrategySortOrderSchema

An array of strategies with their new sort order

Array [

id stringrequired

The ID of the strategy

Example: 9c40958a-daac-400e-98fb-3bb438567008

sortOrder numberrequired

The new sort order of the strategy

Example: 1

]

createdBy

object

The user who created this change.

username stringnullable

The user's username.

imageUrl urinullable

The URL where the user's image can be found.

createdAt date-time

When this change was suggested

Example: 2023-07-31T13:22:03+02:00

]

defaultChange

object

A description of a default change that will be applied with the change request to prevent invalid states.

Default changes are changes that are applied in addition to explicit user-specified changes when a change request is applied. Any default changes are applied in the background and are not a real part of the change request.

action stringrequired

The kind of action this is.

Example: addStrategy

payload objectrequired

The necessary data to perform this change.

Example: {"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

object[]

required

The list of segments and their changes that relate to this change request.

Array [

id numberrequired

The ID of this change.

Example: 33

action stringrequired

The kind of action that the change contains information about.

Example: updateStrategy

conflict string

A description of the conflict caused by this change. Only present if there are any conflicts.

Example: Strategy has been deleted

payload

object

required

The data required to perform this action.

oneOf

MOD1

string

MOD2

boolean

MOD3

object

MOD4

number

setStrategySortOrderSchema

An array of strategies with their new sort order

Array [

id stringrequired

The ID of the strategy

Example: 9c40958a-daac-400e-98fb-3bb438567008

sortOrder numberrequired

The new sort order of the strategy

Example: 1

]

createdBy

object

The user who created this change.

username stringnullable

The user's username.

imageUrl urinullable

The URL where the user's image can be found.

createdAt date-time

When this change was suggested

Example: 2023-07-31T13:22:03+02:00

name stringrequired

The current name of the segment

Example: beta-users

]

approvals

object[]

A list of approvals that this change request has received.

Array [

createdBy

object

required

Information about the user who gave this approval.

id number

The ID of the user who gave this approval.

Example: 33

username string

The approving user's username.

Example: unleash-user

imageUrl uri

The URL where the user's image can be found.

createdAt date-timerequired

When the approval was given.

Example: 2022-12-12T12:13:24.218Z

]

rejections

object[]

A list of rejections that this change request has received.

Array [

createdBy

object

required

Information about the user who gave this approval.

id number

The ID of the user who gave this approval.

Example: 33

username string

The approving user's username.

Example: unleash-user

imageUrl uri

The URL where the user's image can be found.

createdAt date-timerequired

When the approval was given.

Example: 2022-12-12T12:13:24.218Z

]

comments

object[]

All comments that have been made on this change request.

Array [

id number

The comment's ID. Unique per change request.

Example: 33

text stringrequired

The content of the comment.

Example: This is a comment

createdBy

object

required

Information about the user who posted the comment

username stringnullable

The user's username.

Example: unleash-user

imageUrl urinullable

The URL where the user's image can be found.

createdAt date-timerequired

When the comment was made.

Example: 2022-12-12T12:13:24.218Z

]

createdBy

object

required

The user who created this change request.

username stringnullable

Example: Hunter

imageUrl urinullable

The URL of the user's profile image.

createdAt date-timerequired

When this change request was created.

Example: 2023-07-31T13:33:02Z

state stringrequired

The current state of the change request.

Possible values: [Scheduled]

schedule

object

required

A schedule for a change request's application. The schedule can either be pending, failed, or suspended. The schedule will always contain the state of the schedule and the last scheduled time, but other data varies between the different states.

oneOf

MOD1

A pending schedule for a change request.

scheduledAt date-timerequired

When this change request will be applied.

Example: 2023-07-31T13:33:02Z

status stringrequired

The status of the schedule.

Possible values: [pending]

Example: pending

MOD2

A failed schedule for a change request.

scheduledAt date-timerequired

When Unleash last attempted to apply this change request.

Example: 2023-07-31T13:33:02Z

status stringrequired

The status of the schedule.

Possible values: [failed]

Example: failed

reason stringrequired

The reason the scheduled failed to apply.

Example: conflicts

failureReason stringnullabledeprecated

The reason the scheduled failed to apply. Deprecated in favor of the reason property.

Example: conflicts

MOD3

A suspended schedule for a change request.

scheduledAt date-timerequired

When Unleash would have attempted to apply this change request if the schedule was not suspended.

Example: 2023-07-31T13:33:02Z

status stringrequired

The status of the schedule.

Possible values: [suspended]

Example: suspended

reason stringrequired

Why the schedule was suspended.

Example: The user who scheduled this change request (user id: 123) has been deleted from this Unleash instance.

Loading...