Update a client user

Update a user of a client company

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:

{
    "email": "[email protected]"
}

Sending roles replaces the user's roles entirely. As for Create a client user, every role can be assigned and advanced roles do not require the Governance add-on. Setting active to false deactivates the user (see Deactivate a client user); setting it back to true reactivates them.

Unlike Update a user, you can change the email of a super admin, and of a user whose company enforces SSO. The user's previous SSO identity is cleared: they sign in again with the new address.

The company-level rules still apply: you cannot remove the last active super admin of the client company, nor leave it without a single active paying license.

📘

Requires the write_clients permission scope on the API key of a reseller account.

❗️

A company that is not one of your clients, including your own reseller company, answers 404.

Path Params
string
required

UUID of one of your client companies.

string
required

UUID of the user.

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 not already used in any Leexi company.

string

Either free or the client 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. Unlike the regular endpoints, a reseller key may assign every role, super_admin and system_admin included, and advanced roles do not require the Governance add-on of the client company.

roles
string

The uuid of the team the user belongs to.

Responses

401

401

402

402

429

429

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