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
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 components
Upload a component module
Submit a component's source
Retrieve a component
Update a component
Delete a component
List a component's versions
Retrieve a component version
Update a component version
List component uses

Update a component version

Deprecates a version (isDeprecated: true) or lifts its deprecation.

A deprecated version cannot be newly inserted or published; placed instances keep rendering and published paywalls keep working.

Guide: Components

Errors

StatustypecodeWhen
404not_foundcomponent_version_not_found—

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Components

  • List components GET
  • Upload a component module POST
  • Submit a component's source POST
  • Retrieve a component GET
  • Update a component PATCH
  • Delete a component DELETE
  • List a component's versions GET
  • Retrieve a component version GET
  • List component uses GET

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousRetrieve a component versionNextList component uses

On this page

AuthorizationPath parametersRequest bodyExamplesResponse bodyErrorsMore in Components
PATCH
/api/v1/projects/{projectId}/components/{componentId}/versions/{versionId}

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.

componentId*string

The component's id, cmp_....

versionId*string

The id of the component's version, cmp_ver_....

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

isDeprecated?|

true deprecates the version; false lifts its deprecation.

Examples

curl -X PATCH "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/components/cmp_p4z7c1x9v3b8n2m6q5w0e4r7/versions/cmp_ver_h4j8k2l6z0x3c7v1b5n9m3q7" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "isDeprecated": true  }'
{  "id": "cmp_ver_h4j8k2l6z0x3c7v1b5n9m3q7",  "componentId": "cmp_p4z7c1x9v3b8n2m6q5w0e4r7",  "version": 2,  "sourceKind": "rust",  "status": "ready",  "contentHash": "a7c3e9f1b5d2068e4a1c7f3b9d5e0a2c6f8b4d1e7a3c9f5b0d2e8a4c6f1b3d7e",  "panelHash": null,  "byteSize": 57340,  "manifest": {    "id": "project/plan-picker",    "version": "0.1.0",    "title": "Plan picker",    "description": "Selectable plans.",    "icon": {      "kind": "builtin",      "name": "component"    },    "category": "Project",    "keywords": [],    "implementation": {      "kind": "wasm",      "abi": 2    },    "traits": {      "frame": {        "resize": "width"      },      "appearance": {},      "effects": {}    },    "children": {      "kind": "none"    },    "props": [      {        "name": "plans",        "type": {          "kind": "list",          "of": {            "kind": "product"          }        },        "default": []      },      {        "name": "accent",        "type": {          "kind": "color"        },        "default": "#7c3aed"      }    ],    "events": [      {        "name": "selected",        "payload": [          {            "name": "productId",            "type": {              "kind": "string"            }          }        ]      }    ],    "previewStates": [      "default"    ],    "capabilities": [      "commerce"    ],    "panel": false,    "fallback": "placeholder",    "defaultSize": {      "width": "fill",      "height": "hug"    }  },  "isDeprecated": true,  "deprecatedAt": "2026-03-05T09:00:00.000Z",  "warnings": [],  "conformance": {    "hasPassed": true,    "checks": [      {        "name": "module",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "manifest",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "imports",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "exports",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "lifecycle",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "values",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "tree",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "determinism",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "events",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "timers",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "layout",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "actions",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "frames",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "memory",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "golden",        "status": "skip",        "errors": [],        "warnings": []      }    ]  },  "createdBy": "user_k3m8q1z6v9c2x5b7n4w0e8r1",  "createdAt": "2026-02-27T12:10:00.000Z",  "builtAt": "2026-02-27T12:11:05.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": "component_version_not_found",    "message": "This component has no version cmp_ver_k3m8x2c7v9b4n1q6w5e0r8t2.",    "param": "versionId"  }}

{  "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