Skip to main content
Upload your file using the S3 key format companyName_companyId/USER/filename.csv, where USER is the TYPE-SUBTYPE folder value for user uploads. See File Requirements & Validation for encoding, delimiter, and validation rules.
string
required
The email address of the user.
string
required
The first name of the user
string
required
The last name of the user
string
Users phone number
string
Users job title
Clients external reference UUID for the user
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.
string
Name of line manager
bool
default:"False"
Set to True to send a welcome email when a user is created. By default, no email is sent
string
default:"Active"
User status, accepts values of “Active” or “Inactive”.
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.
bool
Controls whether an email subscription (personal-inbox connection) exists for this user. Blank/absent = no action (default; existing files behave exactly as before). True = ensure a subscription exists. False = ensure any existing subscription is removed.The provider is chosen automatically — Gmail if is_google_workspace_user is true, otherwise Office 365. Subscriptions are also removed automatically when the user is set to Inactive or removed from the upload.