Update a user

Update a user of your workspace

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Only the attributes present in the body are updated, so you can send a single field:

{
    "team_uuid": "5290728d-b3c4-4330-918d-d8f153e9500d"
}

Sending roles replaces the user's roles entirely. You may resend a privileged role the user already holds, but the API never grants a new one (see Create a user). Setting active to false deactivates the user (see Deactivate a user); setting it back to true reactivates them.

A few workspace-level rules still apply: you cannot remove the last active super admin, you cannot leave your workspace without a single active paying license, and you cannot change a user's email while SSO is enforced for your company or when the user is a super admin.

📘

Requires the write_users permission scope on the API key.

Path Params
string
required
Body Params
boolean

Defaults to true on creation. Set to false to deactivate the user.

string

The user's email address. It must be deliverable and unique within your workspace.

string

Either free or your company's own license category. Any other value is ignored.

string

The user's full name.

roles
array of strings

Role names. Defaults to ["member"] on creation. Privileged roles (super_admin, system_admin, billing_manager) cannot be assigned through the API; grant them from Leexi > Settings > Users.

roles
string

The uuid of the team the user belongs to.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json