Toggle a feature in one or more environments

Enables or disables a feature in one or more environments simultaneously. Accepts a map of environment name → boolean and immediately publishes the change.

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}/toggle

cURL

cURL

curl -X POST https://api.growthbook.io/api/v1/features/my-feature/toggle \
  -d '{ "reason": "Kill switch activated", "environments": { "production": false } }' \
  -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

environments · object · required

Show child attributes

reason · string

Response

200 - application/json

Success

feature · object · required

Show child attributes