Update a feature flag
Turns a flag on or off, changes its rollout, key or description.
Guide: Feature flags and A/B tests
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The project's id, proj_.... A secret key works only in the project it belongs to.
The flag's id, ff_....
Request body
application/json
TypeScript definitions
Use the request body type in TypeScript.
The new key; apps asking for the old one stop receiving the flag.
The new description; null clears it.
true turns the flag on, false turns it off for everyone, overrides included.
The share of eligible end users the flag is on for, from 0 to 100 in steps of 0.01. Raising it keeps those it was already on for.
Examples
curl -X PATCH "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/feature-flags/ff_v8b3n5q0w2e7h7d2k9m4x1c6" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "isEnabled": true, "rolloutPercentage": 50 }'{ "id": "ff_v8b3n5q0w2e7h7d2k9m4x1c6", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "key": "new-checkout", "description": "The redesigned checkout screen.", "type": "boolean", "isEnabled": true, "rolloutPercentage": 50, "isArchived": false, "experimentId": null, "createdAt": "2026-02-24T10:12:45.000Z", "updatedAt": "2026-03-09T08:30:00.000Z"}{ "error": { "type": "invalid_request", "code": "invalid_body", "message": "The request body is invalid: Expected object" }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "project_not_found", "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.", "param": "projectId" }}{ "error": { "type": "conflict", "code": "feature_flag_key_taken", "message": "Another feature flag in this project, archived or not, already uses the key \"new-onboarding\".", "param": "key" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 409 | conflict | feature_flag_key_taken | When another flag uses the key. |
| 409 | conflict | feature_flag_managed_by_experiment | For an experiment's flag. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Feature flags
- List feature flags
GET - Create a feature flag
POST - Evaluate flags for an end user
POST - Retrieve a feature flag
GET - Archive a feature flag
POST - Unarchive a feature flag
POST - List a flag's variants
GET - Replace a flag's variants
PUT - List a flag's overrides
GET - Set an override
PUT - Remove an override
DELETE - List an end user's overrides
GET - List a flag's targets
GET - Add a target
PUT - Remove a target
DELETE
Something wrong or missing on this page? Tell us by email or on Discord.