v1

latestOpenAPI 3.1.0proprietary2026-07-24156175241.3 KB
Workspaces

Update a Workspace

Update a Workspace's name, description, color, custom metadata, or containing workspace.

patch/v1/workspaces/{workspace_id}

Request body

namestring nullable

The new name for the Workspace. Must be unique within the organization. Cannot be changed for the default Workspace.

descriptionstring nullable

The description of the Workspace.

colorstring nullable

The color of the Workspace.

custom_metadataobject nullable

Custom metadata to associate with the Workspace.

containing_workspace_idinteger nullable

The ID of the Workspace to move this Workspace under. Pass null to move it to the root.

Response

The request has succeeded.

idinteger

The unique identifier of the Workspace.

namestring

The name of the Workspace.

descriptionstring nullable

The description of the Workspace.

colorstring nullable

The color of the Workspace.

custom_metadataobject nullable

Custom metadata associated with the Workspace.

containing_workspace_idinteger nullable

The ID of the Workspace that contains this Workspace, if any.