Replace a flag's variants
Replaces the flag's variants with the ones given and answers all of them.
Name an existing variant's id to keep it, so end users in it stay there; variants left out are removed, and traffic splits evenly.
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.
Every variant the flag has from now on; variants left out are removed, and traffic splits evenly between these.
Examples
curl -X PUT "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/feature-flags/ff_d2k9m4x1c6v8b3n5q0w2e7h7/variants" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "variants": [ { "id": "ff_var_b3n5q0w2e7h7d2k9m4x1c6v8", "label": "Plain", "value": "Go Pro" }, { "label": "Price", "value": "Pro for $4.99 a month" } ] }'{ "data": [ { "id": "ff_var_b3n5q0w2e7h7d2k9m4x1c6v8", "key": "ff_var_b3n5q0w2e7h7d2k9m4x1c6v8", "label": "Plain", "value": "Go Pro", "weightPercentage": 50 }, { "id": "ff_var_m4x1c6v8b3n5q0w2e7h7d2k9", "key": "ff_var_m4x1c6v8b3n5q0w2e7h7d2k9", "label": "Price", "value": "Pro for $4.99 a month", "weightPercentage": 50 } ], "pageInfo": { "endCursor": null, "hasNextPage": false }}{ "error": { "type": "invalid_request", "code": "invalid_variants", "message": "Boolean feature flags cannot have variants", "param": "variants" }}{ "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_variants | When values do not match the flag's type, an id is not one of its variants, or an environment still serves or overrides a variant being removed. |
| 409 | conflict | feature_flag_managed_by_experiment | For an experiment's flag; set an experiment's arms through the experiment. |
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 - Set who gets a flag in an environment
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.