Sign in

v56

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01142337440.5 KB
WorkspaceAdminService
Workspace Admin

Update a workspace

Updates a workspace's metadata (e.g. name) and spec. Admin only.

patch/v1/account/workspaces/{workspaceId}

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

Workspace ID to update (path).

Request body

workspaceIdstring

Workspace ID to update (path).

updateMaskstring field-mask

Fields to update.

Example request

{
  "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
}

Response

OK

status'STATUS_ENABLED' | 'STATUS_DISABLED' | 'STATUS_ARCHIVED' enum

Lifecycle status of the workspace. Archived workspaces reject all requests scoped to them. Server-populated.

Example response

{
  "metadata": {
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  }
}