Sign in

v1

latestOpenAPI 3.0.02026-07-13103151174.7 KB
Feature Configurations

Update a Feature configuration

Update a Feature configuration by environment key or ID

patch/v1/projects/{project}/features/{feature}/configurations

Path parameters

featurestring required

A Feature key or ID

projectstring required

A Project key or ID

Query parameters

environmentstring required

A Environment key or ID

Request body

status'active' | 'inactive'

Status of the Feature Configuration

Example request

{
  "targets": [
    {
      "_id": "61450f3daec96f5cf4a49946",
      "name": "Feature Enabled",
      "distribution": [
        {
          "percentage": 0.0005,
          "_variation": "variation-1"
        }
      ],
      "audience": {
        "name": "Android Users",
        "filters": {
          "filters": [
            {
              "subType": "email",
              "comparator": "!=",
              "values": [
                "baduser@email.com"
              ],
              "type": "user"
            }
          ]
        }
      }
    }
  ]
}

Response

_featurestring required

ID of the Feature owning the Configuration

_environmentstring required

ID of the Environment owning the Configuration

_createdBystring

User who created the Feature Configuration

status'active' | 'inactive' required

Status of the Feature Configuration

startedAtstring date-time

Date the Feature Configuration was started

updatedAtstring date-time required

The date the Feature Configuration was last updated

readonlyboolean required

Controls whether the feature configuration is editable for a given user

hasStaticConfigboolean required

Flag to indicate if the Feature owning the configuration has been marked as complete. If true, the user targeting rules are ignored and the static variation is always used.

Example response

{
  "_feature": "61450f3daec96f5cf4a49946",
  "_environment": "61450f3daec96f5cf4a49946",
  "targets": [
    {
      "_id": "61450f3daec96f5cf4a49946",
      "name": "Feature Enabled",
      "audience": {
        "name": "Android Users",
        "filters": {
          "filters": [
            {
              "subType": "email",
              "comparator": "!=",
              "values": [
                "baduser@email.com"
              ],
              "type": "user"
            }
          ]
        }
      },
      "distribution": [
        {
          "percentage": 0.0005,
          "_variation": "variation-1"
        }
      ],
      "bucketingKey": "'organization_id"
    }
  ]
}