Create a client user

Create a user in a client company

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

Example payload

name, email and team_uuid are required, and the team must belong to the client company. roles defaults to ["member"] and license defaults to the client company's license category.

{
    "name": "John Smith",
    "email": "[email protected]",
    "team_uuid": "5290728d-b3c4-4330-918d-d8f153e9500d",
    "roles": ["super_admin"],
    "license": "business"
}

This endpoint follows the rules a reseller admin gets in Kite, which are looser than Create a user:

  • every role can be assigned, super_admin and system_admin included;
  • advanced roles do not require the Governance add-on of the client company;
  • when the client company has no active super admin yet, the new user becomes its super admin, whatever roles says. The first user you create for a new client is therefore its super admin.

The user is created without a password: they receive a welcome email with a link to set one. Pass "send_welcome_email": false to provision users silently.

An email is unique across Leexi: an address already used in any company answers 409.

📘

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.

Body Params
boolean

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

string
required

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
required

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
boolean

Defaults to true. Set to false to create the user without sending them the welcome email.

string
required

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