Create a user

Create a user in your workspace. The user receives a welcome email with a link to set their password, unless send_welcome_email is false.

post/users

Request

  • Base URL: https://public-api.leexi.ai/v1
  • URL: https://public-api.leexi.ai/v1/users
  • Auth: API key in header Authorization

Request body

activeboolean

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

emailstring required

The user's email address. It must be deliverable and not already used in any Leexi company.

licensestring

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

namestring required

The user's full name.

rolesstring[]

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.

send_welcome_emailboolean

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

team_uuidstring required

The uuid of the team the user belongs to.

Response

200

messagestring
successboolean

Example response

{
  "data": {
    "active": true,
    "created_at": "2024-06-14T11:00:33.534Z",
    "email": "john.smith@acme.com",
    "license": "business",
    "name": "John Smith",
    "roles": [
      "member"
    ],
    "team": {
      "active": true,
      "name": "Sales Team",
      "uuid": "5290728d-b3c4-4330-918d-d8f153e9500d"
    },
    "updated_at": "2024-06-14T11:00:33.534Z",
    "uuid": "befb9860-8661-442a-9496-8743de9e17cd"
  },
  "message": "User successfully created",
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.