latestOpenAPI 3.0.02026-08-08270135.7 KB

c1404d1545ba

workspace
users

Update workspace user

Update the metadata of a specific user in the current workspace by user ID.

You can update:
- Name or profile picture
- Workspace role (member or admin)
- Workspace teams or preferences

<Callout type="info">
Email updates are not supported through the public API for security reasons.
</Callout>

**Use cases:**
- Editing user profiles
- Managing user preferences
- Updating team assignments
patch/api/v1/workspaces/users/{userId}

Path parameters

userIdstring required

Request body

namestring
picturestring uri
workspaceTeamsobject
role'member' | 'admin'

Response

This response returns the updated metadata for the workspace user.

isInitializedboolean
createdstring date-time required
uidstring required
idstring required
picturestring uri required
emailstring email required
namestring required
updatedstring date-time required
workspaceTeamsobject required
subscriptionStatusstring
lastActivestring date-time
lastActiveRefreshedAtstring date-time
lastVisitedScenesstring[]
lastEditedScenesstring[]
libraryVersionnumber
role'member' | 'admin' required