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}

Update a feature flag configuration for a specific environment

cURL

curl --request PATCH \
  --url https://api.kameleoon.com/feature-flags/{siteCode}/{featureKey}/{environmentKey} \
  --header 'Content-Type: application/json' \
  --data '
{
  "featureKey": "<string>",
  "integrations": {
    "deliveryRules": "<array>",
    "experimentRules": "<array>"
  },
  "name": "<string>",
  "rolloutRules": [
    {
      "exposition": 50,
      "id": 123,
      "name": "<string>",
      "orderIndex": 123,
      "reallocation": true,
      "rollbackConditions": [
        {
          "goalId": 123,
          "matchValue": 50.00005,
          "visitors": 2,
          "id": 123,
          "recipients": [
            "[e-mail]"
          ]
        }
      ],
      "segmentId": 123,
      "controlVariationKey": "<string>",
      "multiArmedBandit": true,
      "trafficAllocations": [
        {
          "exposition": 123,
          "variationId": 123,
          "variationKey": "<string>"
        }
      ]
    }
  ],
  "secondaryGoalIds": [
    123
  ],
  "tags": [
    "<string>"
  ],
  "variables": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "variations": [
    {
      "key": "<string>",
      "name": "<string>",
      "variables": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "attributionWindow": 123,
  "bucketingKey": {
    "customDataId": 123
  },
  "defaultVariationKey": "<string>",
  "description": "<string>",
  "featureEnabled": true,
  "isArchived": true,
  "primaryGoalId": 123
}
'

200

{
  "featureKey": "<string>",
  "id": 123,
  "name": "<string>",
  "siteCode": "<string>",
  "archived": true,
  "attributionWindow": 123,
  "bucketingKey": {
    "customDataId": 123
  },
  "createdById": 123,
  "dateContentModified": "2023-11-07T05:31:56Z",
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateModified": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "environmentConfigurations": [
    {
      "dateModified": "2023-11-07T05:31:56Z",
      "defaultVariationKey": "<string>",
      "environmentKey": "<string>",
      "featureEnabled": true,
      "integrations": {
        "deliveryRules": "<array>",
        "experimentRules": "<array>"
      },
      "rolloutRules": [
        {
          "experimentId": 123,
          "id": 123,
          "name": "<string>",
          "release": {
            "releaseFrom": "2025-06-01T00:00:00Z",
            "releaseTo": "2025-06-01T23:59:00Z",
            "timeZone": "Europe/Paris"
          },
          "rollbackConditions": [
            {
              "goalId": 123,
              "id": 123,
              "matchValue": 50,
              "recipients": [
                "<string>"
              ],
              "visitors": 1000
            }
          ],
          "segmentId": 123,
          "trafficAllocations": [
            {
              "exposition": 123,
              "variationId": 123,
              "variationKey": "<string>"
            }
          ],
          "controlVariationKey": "<string>",
          "exposition": 50,
          "multiArmedBandit": true
        }
      ]
    }
  ],
  "primaryGoalId": 123,
  "secondaryGoalIds": [
    123
  ],
  "tags": [
    "<string>"
  ],
  "teamId": 123,
  "variables": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "variations": [
    {
      "key": "<string>",
      "name": "<string>",
      "variables": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ]
}

Path Parameters

siteCode · string · required

Required string length: 10

featureKey · string · required

environmentKey · string · required

Body

application/json

Represents the input object for patching a feature flag for a specific environment

featureKey · string · required

Key used to identify the feature flag

Required string length: 1 - 255

integrations · object · required

Integrations associated with the feature flag environment

Show child attributes

name · string · required

Name of the feature flag

Required string length: 1 - 100

rolloutRules · object[] · required

The rollout rules for this environment

Represents an experimentation rule configuration

Option 1

Option 2

Option 3

Show child attributes

secondaryGoalIds · integer<int32>[] · required

Secondary goals associated with the feature flag

tags · string[] · required

List of tags associated with the feature flag

variables · object[] · required

Variables associated with the feature flag

Show child attributes

variations · object[] · required

Variations associated with the feature flag

Show child attributes

attributionWindow · integer<int64>

Attribution window in milliseconds

bucketingKey · object

Option 1

Option 2

Show child attributes

defaultVariationKey · string

The default variation key to serve in this environment

Maximum string length: 255

description · string

Description of the feature flag

Maximum string length: 5000

featureEnabled · boolean

Indicates if the feature flag is enabled in this environment

isArchived · boolean

Flag indicating if the feature flag is archived

primaryGoalId · integer<int32>

Primary goal associated with the feature flag

Response

200

application/json

OK

Configuration for the feature flag

featureKey · string · required

Key used to identify the feature flag

Required string length: 1 - 255

id · integer<int32> · required · read-only

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

name · string · required

Name of the feature flag

Required string length: 1 - 100

siteCode · string · required

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

Required string length: 1 - 10

archived · boolean

attributionWindow · integer<int64>

Attribution window

bucketingKey · object

Bucketing key used for the feature flag

Option 1

Option 2

Show child attributes

createdById · integer<int32> · read-only

Created by id

dateContentModified · string<date-time> · read-only

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

dateCreated · string<date-time> · read-only

Date and time when the feature flag configuration was created

dateModified · string<date-time> · read-only

Date and time when the feature flag configuration was last modified

description · string

Description of the feature

Maximum string length: 5000

environmentConfigurations · object[]

Environment-specific configurations for the feature flag

Show child attributes

health · enum<string> · read-only

Health of the feature flag (for temporary ones)

Available options: PERMANENT, HEALTHY, STALE, SMELLY

primaryGoalId · integer<int32>

Primary goal of the feature flag

secondaryGoalIds · integer<int32>[]

Secondary goals associated with the feature flag

tags · string[]

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

teamId · integer<int64> · read-only

Team id

variables · object[]

Variables associated with the feature flag

Show child attributes

variations · object[]

Variations associated with the feature flag

Show child attributes