v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB

Workspace

Update a Workspace

Updates a given Workspace. Any parameters not provided are left unchanged.

patch/workspaces/{workspaceId}

Path parameters

workspaceIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Workspace Id

Request body

namestring safe-string

This property is a Safe String.

external_namestring safe-string nullable

This property is a Safe String.

Example request

{
  "name": "Sales",
  "external_name": "UK Sales"
}

Response

idstring uuid required

namestring required

external_namestring nullable required

defaultboolean required

created_atstring date-time required

updated_atstring date-time required

deleted_atstring date-time nullable required

Example response

{
  "id": "89120884-d29a-4b1a-ac7b-a9e73a872795",
  "created_at": "2024-01-18T22:59:00Z",
  "updated_at": "2024-01-18T22:59:00Z",
  "users": [
    {
      "id": "89120884-d29a-4b1a-ac7b-a9e73a872795"
    }
  ]
}