Update a feature flag configuration for a specific environment

Update the feature flag (using JSON Merge for patch) for the given site code, feature key and environment key

Path Parameters

siteCode string required
featureKey string required
environmentKey string required

application/json

Request Body required

defaultVariationKey string
Possible values: <= 255 characters
The default variation key to serve in this environment
description string
Description of the feature
featureEnabled boolean
Indicates whether the feature flag is enabled in this environment
featureKey string
Key used to identify the feature flag
integrations object
Integrations associated with the feature flag environment
deliveryRules object[]
List of integrations enabled for delivery rules
Array [
customAnalytics string[]
Name of the custom analytics
customVariable int32
Integration custom variable
integrationName string
Possible values: [GOOGLE_ANALYTICS4, GOOGLE_ANALYTICS4_AUDIENCES, GOOGLE_UNIVERSAL_ANALYTICS, ECONDA, SMART_TAG, PIANO, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, KISSMETRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, SMARTFOCUS, EMARSYS, EXPERTSENDER, TAG_COMMANDER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATIONS, HEAP, SEGMENT, MIXPANEL, CLARITY, IABTCF, REDSHIFT, SMARTLOOK, MOUSEFLOW, KLAVIYO, FULLSTORY, AMPLITUDE, SNOWPLOW, JUNE, MPARTICLE, BIGQUERY, RUDDERSTACK, SNOWFLAKE, GLASSBOX, HUBSPOT, AIR360, DATADOG, QUANTUM_METRIC, KAMELEOON_TRACKING, CUSTOM_TRACKING, VERCEL, AKAMAI]
Name of the integration
]
experimentRules object[]
List of integrations enabled for experimentation rules
Array [
customAnalytics string[]
Name of the custom analytics
customVariable int32
Integration custom variable
integrationName string
Possible values: [GOOGLE_ANALYTICS4, GOOGLE_ANALYTICS4_AUDIENCES, GOOGLE_UNIVERSAL_ANALYTICS, ECONDA, SMART_TAG, PIANO, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, KISSMETRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, SMARTFOCUS, EMARSYS, EXPERTSENDER, TAG_COMMANDER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATIONS, HEAP, SEGMENT, MIXPANEL, CLARITY, IABTCF, REDSHIFT, SMARTLOOK, MOUSEFLOW, KLAVIYO, FULLSTORY, AMPLITUDE, SNOWPLOW, JUNE, MPARTICLE, BIGQUERY, RUDDERSTACK, SNOWFLAKE, GLASSBOX, HUBSPOT, AIR360, DATADOG, QUANTUM_METRIC, KAMELEOON_TRACKING, CUSTOM_TRACKING, VERCEL, AKAMAI]
Name of the integration
]
name string
Name of the feature flag
primaryGoalId int64
Primary goal associated with the feature flag
rolloutRules object[]
The rollout rules for this environment
Array [
oneOf
FeatureRolloutExperimentationRule
FeatureRolloutProgressiveRule
FeatureRolloutTargetedRule
controlVariationKey string
exposition int32
Possible values: <= 100
Percentage of the traffic exposed to this rule
multiArmedBandit boolean
Enable dynamic allocation for this rule (Multi-Armed Bandit)
name string
Name of the rule
reallocation boolean
Perform traffic reallocation
release object
Release date information about this rule
releaseFrom date-time
Rule being applied from this date
releaseTo date-time
Rule being applied to this date
timeZone string
Timezone regarding the release of this rule
rollbackConditions object[]
Conditions for defining rollback
Array [
comparisonOperator string required
Possible values: [GREATER_THAN, LESS_THAN]
The rollback condition comparison operator
criteria string required
Possible values: [UPLIFT, DOWNLIFT, CONVERSION_RATE]
The rollback condition criteria
goalId int64 required
The rollback condition goal ID
matchValue double required
The rollback condition match value
recipients string[]
List of emails of recipients who will be notified when conditions are triggered
target string required
Possible values: [RULE, ENVIRONMENT]
The rollback condition target
visitors int32 required
The rollback condition visitors
]
segmentId int64
ID of the segment targeted by this rule
state string
Possible values: [ACTIVE, PAUSED]
Wished state of the rule
status string
Possible values: [ACTIVE, PAUSED, PLANNED, OUTDATED]
Status of the rule
trafficAllocations object[]
Traffic allocation settings for the rule
Array [
exposition double required
Possible values: <= 100
Percentage of the traffic allocated to this variation
variationId int64
Internally generated ID of the variation
variationKey string required
Possible values: <= 255 characters
Key of the variation
]
name string
Name of the rule
reallocation boolean
Perform traffic reallocation
release object
Release date information about this rule
releaseFrom date-time
Rule being applied from this date
releaseTo date-time
Rule being applied to this date
timeZone string
Timezone regarding the release of this rule
rollbackConditions object[]
Conditions for defining rollback
Array [
comparisonOperator string required
Possible values: [GREATER_THAN, LESS_THAN]
The rollback condition comparison operator
criteria string required
Possible values: [UPLIFT, DOWNLIFT, CONVERSION_RATE]
The rollback condition criteria
goalId int64 required
The rollback condition goal ID
matchValue double required
The rollback condition match value
recipients string[]
List of emails of recipients who will be notified when conditions are triggered
target string required
Possible values: [RULE, ENVIRONMENT]
The rollback condition target
visitors int32 required
The rollback condition visitors
]
rolloutConfiguration object
oneOf
CustomRampUpRollout
ProgressiveExposure
steps object[] required
List of rollout steps
Array [
dateTime date-time
Date time of the step
exposure float
Exposure of the step
]
segmentId int64
Id of the segment targeted by this rule
state string
Possible values: [ACTIVE, PAUSED]
Wished state of the rule
status string
Possible values: [ACTIVE, PAUSED, PLANNED, OUTDATED]
Status of the rule
variationKey string
Key of the variation to serve to visitors matching this rule

exposition int32

Possible values: <= 100

Percentage of the traffic exposed to this rule

name string

Name of the rule

reallocation boolean

Perform traffic reallocation

release object

Release date information about this rule

releaseFrom date-time

Rule being applied from this date

releaseTo date-time

Rule being applied to this date

timeZone string

Timezone regarding the release of this rule

rollbackConditions object[]

Conditions for defining rollback

Array [

comparisonOperator string required

Possible values: [GREATER_THAN, LESS_THAN]

The rollback condition comparison operator

criteria string required

Possible values: [UPLIFT, DOWNLIFT, CONVERSION_RATE]

The rollback condition criteria

goalId int64 required

The rollback condition goal ID

matchValue double required

The rollback condition match value

recipients string[]

List of emails of recipients who will be notified when conditions are triggered

target string required

Possible values: [RULE, ENVIRONMENT]

The rollback condition target

visitors int32 required

The rollback condition visitors

]

segmentId int64

ID of the segment targeted by this rule

state string

Possible values: [ACTIVE, PAUSED]

Wished state of the rule

status string

Possible values: [ACTIVE, PAUSED, PLANNED, OUTDATED]

Status of the rule

variationKey string

Key of the variation to serve to visitors matching this rule

]

secondaryGoalIds int64[]

Secondary goals associated with the feature flag

tags string[]

List of tags associated with the feature flag

variables object[]

Variables associated with the feature flag

Array [

key string

Possible values: <= 255 characters

Key to identify the variable

type string

Possible values: [BOOLEAN, NUMBER, STRING, JSON, JS, CSS]

Type of the variable

value string

Value of the variable

]

variations object[]

Variations associated with the feature flag

Array [

key string

Possible values: <= 255 characters

Key to identify the variation

name string

Name to identify the variation

variables object[]

Set of variables implemented by the variation

Array [

key string

Possible values: <= 255 characters

Key to identify the variable

type string

Possible values: [BOOLEAN, NUMBER, STRING, JSON, JS, CSS]

Type of the variable

value string

Value of the variable

]

Responses

application/json

Schema
Example (from schema)

Schema

dateContentModified date-time
Date and time when the feature flag configuration content was last modified
dateCreated date-time
Date and time when the feature flag configuration was created
dateModified date-time
Date and time when the feature flag configuration was last modified
description string
Description of the feature
environmentConfigurations object[]
Environment-specific configurations for the feature flag
Array [
dateModified date-time
The date when this environment configuration was last modified
defaultVariationKey string
Possible values: <= 255 characters
Default variation key to serve in this environment
environmentKey string
Environment key associated with this configuration
featureEnabled boolean
Indicates whether the feature flag is enabled in this environment
integrations object
Integrations associated with the feature flag environment
deliveryRules object[]
List of integrations enabled for delivery rules
Array [
customAnalytics string[]
Name of the custom analytics
customVariable int32
Integration custom variable
integrationName string
Possible values: [GOOGLE_ANALYTICS4, GOOGLE_ANALYTICS4_AUDIENCES, GOOGLE_UNIVERSAL_ANALYTICS, ECONDA, SMART_TAG, PIANO, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, KISSMETRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, SMARTFOCUS, EMARSYS, EXPERTSENDER, TAG_COMMANDER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATIONS, HEAP, SEGMENT, MIXPANEL, CLARITY, IABTCF, REDSHIFT, SMARTLOOK, MOUSEFLOW, KLAVIYO, FULLSTORY, AMPLITUDE, SNOWPLOW, JUNE, MPARTICLE, BIGQUERY, RUDDERSTACK, SNOWFLAKE, GLASSBOX, HUBSPOT, AIR360, DATADOG, QUANTUM_METRIC, KAMELEOON_TRACKING, CUSTOM_TRACKING, VERCEL, AKAMAI]
Name of the integration
]
experimentRules object[]
List of integrations enabled for experimentation rules
Array [
customAnalytics string[]
Name of the custom analytics
customVariable int32
Integration custom variable
integrationName string
Possible values: [GOOGLE_ANALYTICS4, GOOGLE_ANALYTICS4_AUDIENCES, GOOGLE_UNIVERSAL_ANALYTICS, ECONDA, SMART_TAG, PIANO, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, KISSMETRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, SMARTFOCUS, EMARSYS, EXPERTSENDER, TAG_COMMANDER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATIONS, HEAP, SEGMENT, MIXPANEL, CLARITY, IABTCF, REDSHIFT, SMARTLOOK, MOUSEFLOW, KLAVIYO, FULLSTORY, AMPLITUDE, SNOWPLOW, JUNE, MPARTICLE, BIGQUERY, RUDDERSTACK, SNOWFLAKE, GLASSBOX, HUBSPOT, AIR360, DATADOG, QUANTUM_METRIC, KAMELEOON_TRACKING, CUSTOM_TRACKING, VERCEL, AKAMAI]
Name of the integration
]
rolloutRules object[]
Rollout rules for this environment
Array [
oneOf
FeatureRolloutExperimentationRule
FeatureRolloutProgressiveRule
FeatureRolloutTargetedRule
controlVariationKey string
exposition int32
Possible values: <= 100
Percentage of the traffic exposed to this rule
id int64
Unique identifier of the rule
multiArmedBandit boolean
Enable dynamic allocation for this rule (Multi-Armed Bandit)
name string
Name of the rule
release object
Release date information about this rule
releaseFrom date-time
Rule being applied from this date
releaseTo date-time
Rule being applied to this date
timeZone string
Timezone regarding the release of this rule
rollbackConditions object[]
Conditions for defining rollback
Array [
comparisonOperator string required
Possible values: [GREATER_THAN, LESS_THAN]
The rollback condition comparison operator
criteria string required
Possible values: [UPLIFT, DOWNLIFT, CONVERSION_RATE]
The rollback condition criteria
goalId int64 required
The rollback condition goal ID
id int64
The rollback condition ID
matchValue double required
The rollback condition match value
recipients string[]
List of emails of recipients who will be notified when conditions are triggered
target string required
Possible values: [RULE, ENVIRONMENT]
The rollback condition target
visitors int32 required
The rollback condition visitors
]
segmentId int64
ID of the segment targeted by this rule
state string
Possible values: [ACTIVE, PAUSED]
Wished state of the rule
status string
Possible values: [ACTIVE, PAUSED, PLANNED, OUTDATED]
Status of the rule
trafficAllocations object[]
Traffic allocation settings for the rule
Array [
exposition double required
Possible values: <= 100
Percentage of the traffic allocated to this variation
variationId int64
Internally generated ID of the variation
variationKey string required
Possible values: <= 255 characters
Key of the variation
]
segmentId int64
Id of the segment targeted by this rule
state string
Possible values: [ACTIVE, PAUSED]
Wished state of the rule
status string
Possible values: [ACTIVE, PAUSED, PLANNED, OUTDATED]
Status of the rule
variationKey string
Key of the variation to serve to visitors matching this rule
exposition int32
Possible values: <= 100
Percentage of the traffic exposed to this rule
id int64
Unique identifier of the rule
name string
Name of the rule
release object
Release date information about this rule
releaseFrom date-time
Rule being applied from this date
releaseTo date-time
Rule being applied to this date
timeZone string
Timezone regarding the release of this rule
rollbackConditions object[]
Conditions for defining rollback
Array [
comparisonOperator string required
Possible values: [GREATER_THAN, LESS_THAN]
The rollback condition comparison operator
criteria string required
Possible values: [UPLIFT, DOWNLIFT, CONVERSION_RATE]
The rollback condition criteria
goalId int64 required
The rollback condition goal ID
id int64
The rollback condition ID
matchValue double required
The rollback condition match value
recipients string[]
List of emails of recipients who will be notified when conditions are triggered
target string required
Possible values: [RULE, ENVIRONMENT]
The rollback condition target
visitors int32 required
The rollback condition visitors
]
segmentId int64
ID of the segment targeted by this rule
state string
Possible values: [ACTIVE, PAUSED]
Wished state of the rule
status string
Possible values: [ACTIVE, PAUSED, PLANNED, OUTDATED]
Status of the rule
variationKey string
Key of the variation to serve to visitors matching this rule
]

]

featureKey string

Key used to identify the feature flag

health string

Possible values: [HEALTHY, STALE, SMELLY, PERMANENT]

Health of the feature flag (for temporary ones)

id int64

System-generated field to uniquely identify a feature flag

name string

Name of the feature flag

primaryGoalId int64

Primary goal associated with the feature flag

secondaryGoalIds int64[]

Secondary goals associated with the feature flag

siteCode string

Unique identifier for a project in the Kameleoon app. This is an optional field to be specified in request params.

tags string[]

List of tags associated with the feature flag. This is an optional field needs to specify in request params.

variables object[]

Variables associated with the feature flag

Array [

key string

Possible values: <= 255 characters

Key to identify the variable

type string

Possible values: [BOOLEAN, NUMBER, STRING, JSON, JS, CSS]

Type of the variable

value string

Value of the variable

]

variations object[]

Variations associated with the feature flag

Array [

key string

Possible values: <= 255 characters

Key to identify the variation

name string

Name to identify the variation

variables object[]

Set of variables implemented by the variation

Array [

key string

Possible values: <= 255 characters

Key to identify the variable

type string

Possible values: [BOOLEAN, NUMBER, STRING, JSON, JS, CSS]

Type of the variable

value string

Value of the variable

]

{
  "dateContentModified": "2024-12-20T15:04:33.071Z",
  "dateCreated": "2024-12-20T15:04:33.071Z",
  "dateModified": "2024-12-20T15:04:33.071Z",
  "description": "string",
  "environmentConfigurations": [
    {
      "dateModified": "2024-12-20T15:04:33.071Z",
      "defaultVariationKey": "string",
      "environmentKey": "string",
      "featureEnabled": true,
      "integrations": {
        "deliveryRules": [
          {
            "customAnalytics": [
              "string"
            ],
            "customVariable": 0,
            "integrationName": "GOOGLE_ANALYTICS4"
          }
        ],
        "experimentRules": [
          {
            "customAnalytics": [
              "string"
            ],
            "customVariable": 0,
            "integrationName": "GOOGLE_ANALYTICS4"
          }
        ]
      },
      "rolloutRules": [
        {
          "type": "PROGRESSIVE_DELIVERY",
          "controlVariationKey": "string",
          "exposition": 0,
          "id": 0,
          "multiArmedBandit": true,
          "name": "string",
          "release": {
            "releaseFrom": "2024-12-20T15:04:33.073Z",
            "releaseTo": "2024-12-20T15:04:33.073Z",
            "timeZone": "Europe/Paris"
          },
          "rollbackConditions": [
            {
              "comparisonOperator": "GREATER_THAN",
              "criteria": "UPLIFT",
              "goalId": 0,
              "id": 0,
              "matchValue": 0,
              "recipients": [
                "string"
              ],
              "target": "RULE",
              "visitors": 0
            }
          ],
          "segmentId": 0,
          "state": "ACTIVE",
          "status": "ACTIVE",
          "trafficAllocations": [
            {
              "exposition": 0,
              "variationId": 0,
              "variationKey": "string"
            }
          ]
        },
        {
          "type": "PROGRESSIVE_DELIVERY",
          "currentExposition": 0,
          "id": 0,
          "name": "string",
          "release": {
            "releaseFrom": "2024-12-20T15:04:33.074Z",
            "releaseTo": "2024-12-20T15:04:33.074Z",
            "timeZone": "Europe/Paris"
          },
          "rollbackConditions": [
            {
              "comparisonOperator": "GREATER_THAN",
              "criteria": "UPLIFT",
              "goalId": 0,
              "id": 0,
              "matchValue": 0,
              "recipients": [
                "string"
              ],
              "target": "RULE",
              "visitors": 0
            }
          ],
          "rolloutConfiguration": {
            "type": "PROGRESSIVE_EXPOSURE",
            "steps": [
              {
                "dateTime": "2024-12-20T15:04:33.074Z",
                "exposure": 0
              }
            ]
          },
          "segmentId": 0,
          "state": "ACTIVE",
          "status": "ACTIVE",
          "variationKey": "string"
        },
        {
          "type": "PROGRESSIVE_DELIVERY",
          "exposition": 0,
          "id": 0,
          "name": "string",
          "release": {
            "releaseFrom": "2024-12-20T15:04:33.074Z",
            "releaseTo": "2024-12-20T15:04:33.074Z",
            "timeZone": "Europe/Paris"
          },
          "rollbackConditions": [
            {
              "comparisonOperator": "GREATER_THAN",
              "criteria": "UPLIFT",
              "goalId": 0,
              "id": 0,
              "matchValue": 0,
              "recipients": [
                "string"
              ],
              "target": "RULE",
              "visitors": 0
            }
          ],
          "segmentId": 0,
          "state": "ACTIVE",
          "status": "ACTIVE",
          "variationKey": "string"
        }
      ]
    }
  ],
  "featureKey": "string",
  "health": "HEALTHY",
  "id": 0,
  "name": "string",
  "primaryGoalId": 0,
  "secondaryGoalIds": [
    0
  ],
  "siteCode": "string",
  "tags": [
    "string"
  ],
  "variables": [
    {
      "key": "string",
      "type": "BOOLEAN",
      "value": "string"
    }
  ],
  "variations": [
    {
      "key": "string",
      "name": "string",
      "variables": [
        {
          "key": "string",
          "type": "BOOLEAN",
          "value": "string"
        }
      ]
    }
  ]
}

Update a feature flag configuration for a specific environment​

Update a feature flag configuration for a specific environment