Users

Create a user

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

post/users

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

Example request

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

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

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"
}

Changes

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