v34

OpenAPI 3.1.0raw.githubusercontent.com2026-07-130042.4 KB
workspaces

Update a Workspace

Update the specified Workspace.

patch/v1/organizations/{organizationId}/workspaces/{workspaceId}

Path parameters

organizationIdstring required

The <code>id</code> of the Organization that contains the Workspace.

workspaceIdstring required

The <code>id</code> of the Workspace to update.

Request body

aliasstring

User-friendly alias for the Workspace.

descriptionstring

Brief description of the Workspace.

tagsstring[]

Tags associated with the Workspace.

Example request

{
  "alias": "Production Environment",
  "description": "Main production Workspace for customer data processing",
  "tags": [
    "production",
    "customer-data"
  ]
}

Response

The Workspace has been successfully updated