replace-setting-value-v2
Replaces a feature flag's value and targeting rules in a ConfigCat environment. Specify the new default value and rules; any omitted fields are reset to their original state.
Instructions
This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting
in a specified Environment identified by the SDK key passed in the X-CONFIGCAT-SDKKEY header.
Only the defaultValue, targetingRules, and percentageEvaluationAttribute fields are modifiable by this endpoint.
Important: As this endpoint is doing a complete replace, it's important to set every other field that you don't want to change to its original state. Not listing one means it will reset.
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 a replace request body as below:
{
"defaultValue": {
"boolValue": true
}
}Then besides that the default served value is set to true, all the Targeting Rules are deleted.
So we get a response like this:
{
"defaultValue": {
"boolValue": true
},
"targetingRules": []
}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. |