Sign in

v2

latestOpenAPI 3.1.02026-07-262937191.0 MB
beta.admin.workspaces

Update Workspaces

Update a Workspace.

patch/v1/admin/workspaces/{workspace_uuid}

Path parameters

workspace_uuidstring uuid required

Workspace ID.

Workspace ID.

Request body

namestring nullable

Updated Workspace name.

descriptionstring nullable

Updated Workspace description.

iconstring nullable

Updated Workspace icon.

Example request

{
  "name": "Product Team",
  "description": "Workspace for product and design teams",
  "icon": "★"
}

Response

OK

uuidstring uuid required

Workspace ID.

namestring required

Workspace name.

descriptionstring nullable required

Workspace description.

iconstring nullable required

Workspace icon.

members_countinteger nullable

Number of members in the Workspace.

is_defaultboolean required

Whether this is the default Workspace for the Organization.

Example response

{
  "name": "Product Team",
  "description": "Workspace for product and design teams",
  "icon": "★",
  "spend_limit": {
    "currency": "USD"
  }
}