Skip to main content
PATCH
/
api
/
ui
/
workspaces
/
{workspaceId}
curl -X PATCH https://api.example.com/api/ui/workspaces/workspace_123 \
  -H "Authorization: Bearer YOUR_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production Workspace"
  }'
{
  "ok": true
}

Authentication

This endpoint requires user authentication. You must be a member of the workspace to update it.

Path Parameters

workspaceId
string
required
The unique identifier of the workspace to update

Request Body

name
string
required
The new name for the workspace

Response

ok
boolean
Indicates whether the update was successful
{
  "ok": true
}

Error Responses

error
string
The error code indicating what went wrong
detail
string
Additional details about the error

Error Codes

  • invalid_name (400) - The provided name is invalid or empty
  • update_failed (500) - Failed to update the workspace
curl -X PATCH https://api.example.com/api/ui/workspaces/workspace_123 \
  -H "Authorization: Bearer YOUR_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production Workspace"
  }'