Add a user

Add a user to the company.

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

The first name of the user.

string
required

The last name of the user.

string
required

The email address of the user.

password
required

The password for the user account. Must be at least 8 characters long and include one lowercase letter, one uppercase letter, one number, and one special character.

string

The phone number of the user.

string

The company-specific employee ID.

string

The kiosk employee code which should be only 4 digits long.

number
Defaults to 3

The role of the user (1 for Admin, 2 for Manager, 3 for Employee; default is 3).

boolean
Defaults to false

Indicates if location tracking is enabled (default is false).

boolean
Defaults to false

Indicates if mileage tracking is enabled (default is false).

double
Defaults to 0

The pay rate for the user (default is 0).

integer
Defaults to 0

The billing rate type (0 for hourly, 1 for daily; default is 0)

json
enum

An object containing user-defined custom fields. Each key is a custom field ID, and each value is the corresponding field value. Field IDs and values vary depending on the configuration. Only available on Permium plan. For more details, see the Custom Field Guide.

Allowed:
Responses

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