Partially update a feature

Updates any combination of a feature’s metadata (description, owner, tags, project), default value, environment settings (rules, kill switches, enabled state), prerequisites, holdout assignment, or JSON schema validation. All provided fields are merged into the existing feature and the result is immediately published as a new revision.

Returns 403 if the API key lacks permission or if approval rules are enabled for an affected environment and the org setting “REST API always bypasses approval requirements” is off.

POST /features/{id}

cURL

cURL

curl -X POST https://api.growthbook.io/api/v1/features/test-01 \
  -d '{ "description": "A cool feature flag", ... }'
  -u secret_abc123DEF456:

200

{
  "feature": {
    "id": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "archived": true,
    "description": "<string>",
    "owner": "<unknown>",
    "project": "<string>",
    "valueType": "boolean",
    "defaultValue": "<string>",
    "tags": [
      "<string>"
    ],
    "environments": {},
    "revision": {
      "version": 123,
      "comment": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "publishedBy": "<string>"
    },
    "prerequisites": [
      "<string>"
    ],
    "customFields": {},
    "holdout": {
      "id": "<string>",
      "value": "<string>"
    }
  }
}

Authorizations

bearerAuthbasicAuth

Authorization · string · header · required

If using Bearer auth, pass the Secret Key as the token:

curl https://api.growthbook.io/api/v1 \
  -H "Authorization: Bearer secret_abc123DEF456"

Path Parameters

id · string · required

The id of the requested resource

Body

application/json

description · string

Description of the feature

archived · boolean

project · string

An associated project ID

owner · any

defaultValue · string

tags · string[]

List of associated tags. Will override tags completely with submitted list

environments · object

Show child attributes

prerequisites · string[]

Feature IDs. Each feature must evaluate to true

jsonSchema · string

Use JSON schema to validate the payload of a JSON-type feature value (enterprise only).

customFields · object

Show child attributes

holdout · object

Holdout to assign this feature to. Pass null to remove the feature from its current holdout. Omit the field entirely to leave the holdout unchanged.

Show child attributes

Response

200 - application/json

Success

feature · object · required

Show child attributes