v2

latestOpenAPI 3.0.42026-08-04123200540.7 KB
Feature Flag & Setting values V2

Replace value

This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the <a target="_blank" rel="noopener noreferrer" href="https://app.configcat.com/sdkkey">SDK key</a> 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": []
}
put/v2/environments/{environmentId}/settings/{settingId}/value

Path parameters

environmentIdstring uuid required

The identifier of the Environment.

settingIdinteger required

The id of the Setting.

Query parameters

reasonstring

The reason note for the Audit Log if the Product's "Config changes require a reason" preference is turned on.

bypassApprovalboolean

Whether to bypass the approval process and directly apply the change. This is only applicable for users with bypass approval permission.

latestVersionIdstring uuid

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.

Request body

percentageEvaluationAttributestring nullable

The user attribute used for percentage evaluation. If not set, it defaults to the Identifier user object attribute.

Response

lastVersionIdstring uuid required

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 the version identifier does not match the current version, the update will be rejected with a 409 Conflict response.

updatedAtstring date-time nullable required

The last updated date and time when the Feature Flag or Setting.

percentageEvaluationAttributestring nullable required

The user attribute used for percentage evaluation. If not set, it defaults to the Identifier user object attribute.

lastUpdaterUserEmailstring nullable required

The email of the user who last updated the Feature Flag or Setting.

lastUpdaterUserFullNamestring nullable required

The name of the user who last updated the Feature Flag or Setting.

settingIdsWherePrerequisiteinteger[] required

List of Feature Flag and Setting IDs where the actual Feature Flag or Setting is prerequisite.

changeRequestCountinteger required

The number of change requests for the Feature Flag or Setting.

readOnlyboolean required

Indicates whether you have Read-only access to the Environment.

approveRequiredboolean required

Indicates that a mandatory approval is required for saving and publishing.

canBypassApprovalboolean required

Indicates whether the user can bypass the approval flow.

reasonRequiredboolean required

Indicates that a mandatory note required for saving and publishing.