replace-setting-value
Replace the complete value, rollout rules, and percentage rules of a feature flag setting in a given environment. Omitting an attribute resets it.
Instructions
This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment.
Only the value, rolloutRules and percentageRules attributes are modifiable by this endpoint.
Important: As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means it will reset.
For example: We have the following resource.
{
"rolloutPercentageItems": [
{
"percentage": 30,
"value": true
},
{
"percentage": 70,
"value": false
}
],
"rolloutRules": [],
"value": false
}If we send a replace request body as below:
{
"value": true
}Then besides that the default value is set to true, all the Percentage Rules are deleted.
So we get a response like this:
{
"rolloutPercentageItems": [],
"rolloutRules": [],
"value": true
}The rolloutRules property describes two types of rules:
Targeting rules: When you want to add or update a targeting rule, the
comparator,comparisonAttribute, andcomparisonValuemembers are required.Segment rules: When you want to add add or update a segment rule, the
segmentIdwhich identifies the desired segment and thesegmentComparatormembers are required.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| environmentId | Yes | The identifier of the Environment. | |
| settingId | Yes | The id of the Setting. | |
| reason | No | The reason note for the Audit Log if the Product's "Config changes require a reason" preference is turned on. | |
| requestBody | Yes |