latestOpenAPI 3.0.02026-08-08270135.7 KB

c1404d1545ba

workspace

Update workspace data

Update the current workspace's metadata.

You can update:
- Workspace name
- Workspace picture

**Use cases:**
- Renaming workspaces
- Updating branding or workspace avatars
- Managing workspace settings in admin panels
patch/api/v1/workspaces

Request body

namestring
picturestring uri

Response

This response returns the updated data for the workspace.

idstring required
usersstring[] required
rolesobject required
namestring required
createdstring date-time required
picturestring uri required
subscriptionStatus'payment_failed' | 'active' | 'canceled' | 'trialing' | 'overdue' required
creatorstring required
updaterstring required
apiVersionstring
willCancelAtstring date-time required
blockedUsersstring[]
{"stackTrail":"paths:/api/v1/workspaces:patch:responses:200:content:application/json:schema:properties:type","oasType":"schema","type":"unknown"}
flagsnumber
isDeletedboolean
deletedAtnumber