VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Cohorts
Group types
Groups
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
List feature flags
Create a feature flag
Evaluate flags for an end user
Retrieve a feature flag
Update a feature flag
Archive a feature flag
Unarchive a feature flag
List a flag's variants
Replace a flag's variants
Set who gets a flag in an environment
Make test follow production
List a flag's overrides
Set an override
Remove an override
List an end user's overrides

Update a feature flag

Changes a flag's key or description.

Who gets the flag is set per environment.

Guide: Feature flags and A/B tests

PATCH
/api/v1/projects/{projectId}/feature-flags/{featureFlagId}

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

featureFlagId*string

The flag's id, ff_....

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

key?|

The new key; apps asking for the old one stop receiving the flag.

description?|

The new description; null clears it.

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 '{    "description": "The redesigned checkout screen."  }'
{  "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": null  },  "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

StatustypecodeWhen
409conflictfeature_flag_key_takenWhen another flag uses the key.
409conflictfeature_flag_managed_by_experimentFor 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
  • 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.

PreviousRetrieve a feature flagNextArchive a feature flag

On this page

AuthorizationPath parametersRequest bodyExamplesResponse bodyErrorsMore in Feature flags