Update a component

Renames a component or moves it to another editor group; category: null moves it back to the project's default group.

Errors

Status	`type`	`code`	When
400	`invalid_request`	`invalid_component`	For a title outside 1 to 255 characters or a category over 64.
404	`not_found`	`component_not_found`	—

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

More in Components

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_....

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

title?|

The new title, 1 to 255 characters.

category?|

The editor group to list the component in, at most 64 characters; null moves it back to the project's default group.

Examples

curl -X PATCH "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/components/cmp_p4z7c1x9v3b8n2m6q5w0e4r7" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "category": "Pricing"  }'

{  "id": "cmp_p4z7c1x9v3b8n2m6q5w0e4r7",  "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",  "slug": "plan-picker",  "title": "Plan picker",  "category": "Pricing",  "latestVersion": {    "id": "cmp_ver_k3m8x2c7v9b4n1q6w5e0r8t2",    "componentId": "cmp_p4z7c1x9v3b8n2m6q5w0e4r7",    "version": 3,    "sourceKind": "rust",    "status": "ready",    "contentHash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",    "panelHash": null,    "byteSize": 58912,    "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": false,    "deprecatedAt": null,    "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-03-04T16:20:00.000Z",    "builtAt": "2026-03-04T16:21:12.000Z"  },  "latestReadyVersion": {    "id": "cmp_ver_k3m8x2c7v9b4n1q6w5e0r8t2",    "componentId": "cmp_p4z7c1x9v3b8n2m6q5w0e4r7",    "version": 3,    "sourceKind": "rust",    "status": "ready",    "contentHash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",    "panelHash": null,    "byteSize": 58912,    "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": false,    "deprecatedAt": null,    "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-03-04T16:20:00.000Z",    "builtAt": "2026-03-04T16:21:12.000Z"  },  "createdAt": "2026-02-25T11:00:00.000Z",  "updatedAt": "2026-03-15T08:00:00.000Z"}

{  "error": {    "type": "invalid_request",    "code": "invalid_component",    "message": "The component could not be updated. Titles need 1 to 255 characters and categories at most 64."  }}

{  "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_not_found",    "message": "This project has no component cmp_p4z7c1x9v3b8n2m6q5w0e4r7.",    "param": "componentId"  }}

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

Errors

More in Components

Update a component

Errors

More in Components

Authorization

Path parameters

Request body

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Update a component

Update a component

component_not_found

project_not_found

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`