MOmodjo
Users

Create a user

Changed on

Creates a new user. Email must be unique within the tenant.

post/users

Request

  • Base URL
    https://api.modjo.ai/v2
  • URL
    https://api.modjo.ai/v2/users
  • Auth
    HTTP bearer

Request body

emailstring email required

User email address

firstNamestring required

User first name

lastNamestring required

User last name

phoneNumberstring

User phone number

jobTitlestring

User job title

jobDepartmentstring

User job department

role'user' | 'manager' | 'admin'

User role. Defaults to "user".

timezonestring

IANA timezone identifier

hasLicenseboolean

Assign a license from the workspace pool to the user. Defaults to false. The request fails with 409 when no license is available. In the rare case where a concurrent request takes the last license, the user is created without one and hasLicense is false in the response.

Example request

{
  "email": "jane.doe@company.com",
  "firstName": "Jane",
  "lastName": "Doe",
  "phoneNumber": "+33612345678",
  "jobTitle": "Account Executive",
  "jobDepartment": "Sales",
  "role": "user",
  "timezone": "Europe/Paris",
  "hasLicense": true
}

Response

User created

idnumber required

User ID

emailstring required

User email address

firstNamestring nullable required

User first name

lastNamestring nullable required

User last name

phoneNumberstring nullable required

User phone number

jobTitlestring nullable required

User job title

jobDepartmentstring nullable required

User job department

rolestring required

User role: user, manager, or admin

timezonestring nullable required

IANA timezone identifier

createdOnstring nullable required

Creation timestamp in ISO 8601 format

modifiedOnstring nullable required

Last modification timestamp in ISO 8601 format

hasLicenseboolean required

Whether the user holds a license of the workspace

Example response

{
  "id": 1,
  "email": "john@example.com",
  "phoneNumber": "+33612345678",
  "jobTitle": "Account Executive",
  "jobDepartment": "Sales",
  "role": "user",
  "timezone": "Europe/Paris",
  "createdOn": "2024-06-15T14:30:00.000Z",
  "modifiedOn": "2024-06-15T15:00:00.000Z",
  "hasLicense": true
}

Changes

  • cd38cb80cde1Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status