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"
}'
const response = await fetch('https://api.example.com/api/ui/workspaces/workspace_123', {
method: 'PATCH',
headers: {
'Authorization': 'Bearer YOUR_SESSION_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Production Workspace'
})
});
const data = await response.json();
import requests
response = requests.patch(
'https://api.example.com/api/ui/workspaces/workspace_123',
headers={
'Authorization': 'Bearer YOUR_SESSION_TOKEN',
'Content-Type': 'application/json'
},
json={
'name': 'Production Workspace'
}
)
data = response.json()
{
"ok": true
}
Workspaces
Update workspace
Update workspace settings and configuration
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"
}'
const response = await fetch('https://api.example.com/api/ui/workspaces/workspace_123', {
method: 'PATCH',
headers: {
'Authorization': 'Bearer YOUR_SESSION_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Production Workspace'
})
});
const data = await response.json();
import requests
response = requests.patch(
'https://api.example.com/api/ui/workspaces/workspace_123',
headers={
'Authorization': 'Bearer YOUR_SESSION_TOKEN',
'Content-Type': 'application/json'
},
json={
'name': 'Production Workspace'
}
)
data = response.json()
{
"ok": true
}
Authentication
This endpoint requires user authentication. You must be a member of the workspace to update it.Path Parameters
string
required
The unique identifier of the workspace to update
Request Body
string
required
The new name for the workspace
Response
boolean
Indicates whether the update was successful
{
"ok": true
}
Error Responses
string
The error code indicating what went wrong
string
Additional details about the error
Error Codes
invalid_name(400) - The provided name is invalid or emptyupdate_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"
}'
const response = await fetch('https://api.example.com/api/ui/workspaces/workspace_123', {
method: 'PATCH',
headers: {
'Authorization': 'Bearer YOUR_SESSION_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Production Workspace'
})
});
const data = await response.json();
import requests
response = requests.patch(
'https://api.example.com/api/ui/workspaces/workspace_123',
headers={
'Authorization': 'Bearer YOUR_SESSION_TOKEN',
'Content-Type': 'application/json'
},
json={
'name': 'Production Workspace'
}
)
data = response.json()