Create a user

Create a user in your workspace

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

Example payload

name, email and team_uuid are required. roles defaults to ["member"] and license defaults to your company's license category.

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

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 — they can then set their password through the "forgot password" flow.

📘

Requires the write_users permission scope on the API key.

🚧

A key with the write_users scope creates and deactivates users, which affects your billed licenses. Only grant it to integrations you trust with user management. Privileged roles (super_admin, system_admin, billing_manager) cannot be assigned through the API: grant them from Leexi > Settings > Users.

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 unique within your workspace.

string

Either free or your 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. Privileged roles (super_admin, system_admin, billing_manager) cannot be assigned through the API; grant them from Leexi > Settings > Users.

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

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