Set who gets a flag in an environment
Replaces who gets the flag in one environment: its switch, overrides, rules and fallthrough, read in that order.
Setting test gives test a configuration of its own; until then it follows production.
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_....
The environment whose configuration is meant: production, or test, which a test key reads.
Value in
- "production"
- "test"
Request body
application/json
TypeScript definitions
Use the request body type in TypeScript.
The environment's switch: false turns the flag off for everyone there, overrides included.
End users fixed to an answer, at most 1000; omitted, none.
Rules, read in order, at most 20; omitted, none.
What every end user no rule matches gets.
Examples
curl -X PUT "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/feature-flags/ff_v8b3n5q0w2e7h7d2k9m4x1c6/environments/test" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "isEnabled": true, "fallthrough": { "rolloutPercentage": 100 } }'{ "id": "ff_v8b3n5q0w2e7h7d2k9m4x1c6", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "key": "new-checkout", "description": "The redesigned checkout screen.", "type": "boolean", "environments": { "production": { "isEnabled": true, "overrides": [ { "identityType": "email", "identityValue": "ada@example.com", "isEnabled": true, "variantKey": null, "note": "QA device for the new checkout" } ], "rules": [ { "id": "beta-testers", "name": "Beta testers", "identities": [ { "identityType": "distinct_id", "identityValue": "user_8231" } ], "serve": { "rolloutPercentage": 100, "variantKey": null } } ], "fallthrough": { "rolloutPercentage": 50, "variantKey": null } }, "test": { "isEnabled": true, "overrides": [], "rules": [], "fallthrough": { "rolloutPercentage": 100, "variantKey": null } } }, "isArchived": false, "experimentId": null, "createdAt": "2026-02-24T10:12:45.000Z", "updatedAt": "2026-03-14T09:00:00.000Z"}{ "error": { "type": "invalid_request", "code": "invalid_environment", "message": "The flag has no variant annual-first." }}{ "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_managed_by_experiment", "message": "Feature flag ff_k9m4x1c6v8b3n5q0w2e7h7d2 assigns the arms of experiment exp_c6v8b3n5q0w2e7h7d2k9m4x1; change it through the experiment." }}{ "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 |
|---|---|---|---|
| 400 | invalid_request | invalid_environment | When a variant named is not one of the flag's, or an end user or rule id is listed twice. |
| 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 - Update a feature flag
PATCH - Archive a feature flag
POST - Unarchive a feature flag
POST - List a flag's variants
GET - Replace a flag's variants
PUT - Make test follow production
DELETE - List a flag's overrides
GET - Set an override
PUT - Remove an override
DELETE - List an end user's overrides
GET
Something wrong or missing on this page? Tell us by email or on Discord.