Travtus home page
Search...
⌘K
Ask AI
Search...
Navigation
Data Types & Data Structure
Users
Introduction
Welcome to the Travtus Technical Documentation site.
Deployment Guide
File Uploads
Uploading Data to the Travtus Platform
Data Types & Data Structure
Communities
Units
Vacancies
Resident
Users
Messages
Data Feeds
Chat Widget Deployment
Embedded Gateway
3rd Party Integrations
Travtus API & Webhook
Request Access
API License Agreement
POST
Authentication
Webhook
Data Types & Endpoints
Miscellaneous
Chrome Extension
Glossary
Glossary
Data Types & Data Structure
Users
Below is our standard data structure for a unit:
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”.
Resident
Emails
Assistant
Responses are generated using AI and may contain mistakes.