​
email_address
string
required
The email address of the user.
​
first_name
string
required
The first name of the user
​
last_name
string
required
Enter a description
​
phone_number
string
Users phone number
​
job_title
string
Users job title
​
external_ref
Clients external reference UUID for the user
​
community_ids
string
List of the client external reference ids for the communities to be assigned to the user.Note the external reference ids must have been provided by the client and stored in the Travtus Platform.
​
reports_to
string
Name of line manager
​
send_welcome_mail
bool
Set to True for the user to receive welcome email on user creation
​
status
string
default:"Active"
User status, accepts values of “Active” or “Inactive”.
​
roles
string
default:"none"
Defines the user’s role. Must exactly match a role created by the Admin in the Studio. Multiple roles can be assigned by providing a comma-separated list (e.g., “compass,gateway”). Each role determines the permissions and restrictions for accessing features.