update-setting-value-v2
Update a feature flag or setting in a specific environment using JSON Patch operations to modify default values, targeting rules, or percentage evaluation attributes while leaving other fields unchanged.
Instructions
This endpoint updates the value of a Feature Flag or Setting with a collection of JSON Patch operations in a specified Environment.
Only the defaultValue, targetingRules, and percentageEvaluationAttribute fields are modifiable by this endpoint.
The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. It supports collection reordering, so it also can be used for reordering the targeting rules of a Feature Flag or Setting.
For example: We have the following resource of a Feature Flag.
{
"defaultValue": {
"boolValue": false
},
"targetingRules": [
{
"conditions": [
{
"userCondition": {
"comparisonAttribute": "Email",
"comparator": "sensitiveTextEquals",
"comparisonValue": {
"stringValue": "test@example.com"
}
}
}
],
"percentageOptions": [],
"value": {
"boolValue": true
}
}
]
}If we send an update request body as below:
[
{
"op": "replace",
"path": "/targetingRules/0/value/boolValue",
"value": true
}
]Only the first Targeting Rule's value is going to be set to false and all the other fields are remaining unchanged.
So we get a response like this:
{
"defaultValue": {
"boolValue": false
},
"targetingRules": [
{
"conditions": [
{
"userCondition": {
"comparisonAttribute": "Email",
"comparator": "sensitiveTextEquals",
"comparisonValue": {
"stringValue": "test@example.com"
}
}
}
],
"percentageOptions": [],
"value": {
"boolValue": false
}
}
]
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| reason | No | The reason note for the Audit Log if the Product's "Config changes require a reason" preference is turned on. | |
| settingId | Yes | The id of the Setting. | |
| requestBody | Yes | ||
| environmentId | Yes | The identifier of the Environment. | |
| bypassApproval | No | Whether to bypass the approval process and directly apply the change. This is only applicable for users with bypass approval permission. | |
| latestVersionId | No | Optional. The version identifier of the last change made to the Feature Flag or Setting in the Environment. It can be used to make sure concurrent updates are not overwriting each other. If provided and the version identifier does not match the current version, the update will be rejected with a 409 Conflict response. The latest version id can be acquired from the `LastVersionId` property of the response models. |