Skip to main content

Update a feature flag configuration for a specific environment

PATCH 
/feature-flags/:siteCode/:featureKey/:environmentKey

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

Request​

Path Parameters

    siteCode stringrequired
    featureKey stringrequired
    environmentKey stringrequired

Body

required

    defaultVariationKey string

    The default variation key to serve in this environment

    Possible values: <= 255 characters

    description string

    Description of the feature

    Possible values: <= 5000 characters

    featureEnabled boolean

    Indicates whether the feature flag is enabled in this environment

    featureKey string

    Key used to identify the feature flag

    Possible values: non-empty and <= 255 characters

    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 stringrequired

    Name of the integration

    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]

  • ]

    • experimentRules

    object[]

    List of integrations enabled for experimentation rules

  • Array [

    • customAnalytics string[]

    Name of the custom analytics

    customVariable int32

    Integration custom variable

    integrationName stringrequired

    Name of the integration

    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 string

    Name of the feature flag

    Possible values: non-empty and <= 100 characters

    primaryGoalId int64

    Primary goal associated with the feature flag

    rolloutRules

    object[]

    The rollout rules for this environment

  • Array [

    • oneOf

    Rule which can specify a segment of visitors to be exposed to an experimentation

    type stringrequired

    Type of the rule

    Possible values: [PROGRESSIVE_DELIVERY, TARGETED_DELIVERY, EXPERIMENTATION]

    controlVariationKey string
    exposition int32

    Percentage of the traffic exposed to this rule

    Possible values: <= 100

    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 stringrequired

    Timezone regarding the release of this rule

    Example: Europe/Paris

    rollbackConditions

    object[]

    Conditions for defining rollback

  • Array [

    • comparisonOperator stringrequired

    The rollback condition comparison operator

    Possible values: [GREATER_THAN, LESS_THAN]

    criteria stringrequired

    The rollback condition criteria

    Possible values: [UPLIFT, DOWNLIFT, CONVERSION_RATE]

    goalId int64required

    The rollback condition goal ID

    matchValue doublerequired

    The rollback condition match value

    Possible values: >= 0.0001 and <= 100

    recipients string[]

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

    target stringrequired

    The rollback condition target

    Possible values: [RULE, ENVIRONMENT]

    visitors int32required

    The rollback condition visitors

  • ]

    • segmentId int64

    ID of the segment targeted by this rule

    state string

    Wished state of the rule

    Possible values: [ACTIVE, PAUSED]

    trafficAllocations

    object[]

    Traffic allocation settings for the rule

  • Array [

    • exposition doublerequired

    Percentage of the traffic allocated to this variation

    Possible values: <= 100

    variationId int64

    Internally generated ID of the variation

    variationKey stringrequired

    Key of the variation

    Possible values: <= 255 characters

  • ]

  • ]

    • 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 stringrequired

    Key to identify the variable

    type stringrequired

    Type of the variable

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

    value stringrequired

    Value of the variable

  • ]

    • variations

    object[]

    Variations associated with the feature flag

  • Array [

    • key stringrequired

    Key to identify the variation

    name stringrequired

    Name to identify the variation

    Possible values: <= 255 characters

    variables

    object[]

    Set of variables implemented by the variation

  • Array [

    • key stringrequired

    Key to identify the variable

    type stringrequired

    Type of the variable

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

    value stringrequired

    Value of the variable

  • ]

  • ]

Responses​

OK

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

    Default variation key to serve in this environment

    Possible values: <= 255 characters

    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 stringrequired

    Name of the integration

    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]

  • ]

    • experimentRules

    object[]

    List of integrations enabled for experimentation rules

  • Array [

    • customAnalytics string[]

    Name of the custom analytics

    customVariable int32

    Integration custom variable

    integrationName stringrequired

    Name of the integration

    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]

  • ]

    • rolloutRules

    object[]

    Rollout rules for this environment

  • Array [

    • oneOf

    Rule which can specify a segment of visitors to be exposed to an experimentation

    type stringrequired

    Type of the rule

    Possible values: [PROGRESSIVE_DELIVERY, TARGETED_DELIVERY, EXPERIMENTATION]

    controlVariationKey string
    exposition int32

    Percentage of the traffic exposed to this rule

    Possible values: <= 100

    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 stringrequired

    Timezone regarding the release of this rule

    Example: Europe/Paris

    rollbackConditions

    object[]

    Conditions for defining rollback

  • Array [

    • comparisonOperator stringrequired

    The rollback condition comparison operator

    Possible values: [GREATER_THAN, LESS_THAN]

    criteria stringrequired

    The rollback condition criteria

    Possible values: [UPLIFT, DOWNLIFT, CONVERSION_RATE]

    goalId int64required

    The rollback condition goal ID

    id int64

    The rollback condition ID

    matchValue doublerequired

    The rollback condition match value

    Possible values: >= 0.0001 and <= 100

    recipients string[]

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

    target stringrequired

    The rollback condition target

    Possible values: [RULE, ENVIRONMENT]

    visitors int32required

    The rollback condition visitors

  • ]

    • segmentId int64

    ID of the segment targeted by this rule

    status string

    Status of the rule

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

    trafficAllocations

    object[]

    Traffic allocation settings for the rule

  • Array [

    • exposition doublerequired

    Percentage of the traffic allocated to this variation

    Possible values: <= 100

    variationId int64

    Internally generated ID of the variation

    variationKey stringrequired

    Key of the variation

    Possible values: <= 255 characters

  • ]

  • ]

  • ]

    • featureKey string

    Key used to identify the feature flag

    health string

    Health of the feature flag (for temporary ones)

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

    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 stringrequired

    Key to identify the variable

    type stringrequired

    Type of the variable

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

    value stringrequired

    Value of the variable

  • ]

    • variations

    object[]

    Variations associated with the feature flag

  • Array [

    • key stringrequired

    Key to identify the variation

    name stringrequired

    Name to identify the variation

    Possible values: <= 255 characters

    variables

    object[]

    Set of variables implemented by the variation

  • Array [

    • key stringrequired

    Key to identify the variable

    type stringrequired

    Type of the variable

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

    value stringrequired

    Value of the variable

  • ]

  • ]

Loading...