KAkameleoon
FeatureFlag

Update a feature flag configuration for a specific environment

Updates the configuration of a feature flag using a JSON Merge Patch for the specified site code, feature key, and environment key. Note: If you need to modify an element within an array, the entire array — including all its fields — must be provided, as partial updates to array elements are not supported.

patch/feature-flags/{siteCode}/{featureKey}/{environmentKey}

Request

Path parameters

siteCodestring required
featureKeystring required
environmentKeystring required

Request body

attributionWindowinteger

Attribution window in milliseconds

defaultVariationKeystring

The default variation key to serve in this environment

descriptionstring

Description of the feature flag

featureEnabledboolean

Indicates if the feature flag is enabled in this environment

featureKeystring required

Key used to identify the feature flag

isArchivedboolean

Flag indicating if the feature flag is archived

namestring required

Name of the feature flag

primaryGoalIdinteger

Primary goal associated with the feature flag

secondaryGoalIdsinteger[] required

Secondary goals associated with the feature flag

tagsstring[] required

List of tags associated with the feature flag

Example request

{
  "rolloutRules": [
    {
      "release": {
        "timeZone": "Europe/Paris"
      }
    }
  ]
}

Response

OK

archivedboolean
attributionWindowinteger

Attribution window

createdByIdinteger

Created by id

dateContentModifiedstring date-time

Date and time when the feature flag configuration content was last modified

dateCreatedstring date-time

Date and time when the feature flag configuration was created

dateModifiedstring date-time

Date and time when the feature flag configuration was last modified

descriptionstring

Description of the feature

featureKeystring required

Key used to identify the feature flag

health'PERMANENT' | 'HEALTHY' | 'STALE' | 'SMELLY'

Health of the feature flag (for temporary ones)

idinteger required

System-generated unique string of integers to identify a feature flag

isArchivedboolean
namestring required

Name of the feature flag

primaryGoalIdinteger

Primary goal of the feature flag

secondaryGoalIdsinteger[]

Secondary goals associated with the feature flag

siteCodestring required

Unique Id for the project in the Kameleoon app. This is an optional field to be included as query parameters

tagsstring[]

List of tags associated with the feature flag. This is an optional field to be included as query parameters

teamIdinteger

Team id

Example response

{
  "environmentConfigurations": [
    {
      "rolloutRules": [
        {
          "release": {
            "timeZone": "Europe/Paris"
          },
          "rollbackConditions": [
            {
              "matchValue": 50,
              "visitors": 1000
            }
          ]
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.