Update a workspace

Settings module

PATCH/workspaces/{id}workspaces.update

A workspace inside an organization. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requires the capability org.workspaces.manage.
OAuth scopes: org.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

workspaces.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the workspace.

Request body: WorkspaceUpdate

workspaces.update: WorkspaceUpdate
Field	Type	Required	Description
name	string	No	Workspace name.Constraints: length 1 to 300
slug	string	No	URL slug.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "name": "Festivals",
  "slug": "festivals"
}

Response 200: Workspace

workspaces.update: Workspace
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the workspace.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
name	string	Yes	Workspace name.Constraints: length 1 to 300
slug	string	Yes	URL slug.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Festivals",
  "slug": "festivals"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/workspaces/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"name":"Festivals","slug":"festivals"}'

const { data, etag } = await xos.workspaces.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "name": "Festivals",
    "slug": "festivals"
  }, { ifMatch: etag });

response = xos.workspaces.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "Festivals", "slug": "festivals"}, if_match=etag)

xos workspaces update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"Festivals","slug":"festivals"}' --if-match auto