Skip to main content

Request Body schema: application/json

integer
Unique ID for Resident
string
Type of user (in the case of residents, this is always “Tenant”)
string
The user’s name
string
string <date-time>
string
string <date-time>
integer
Boolean to describe whether the user has opted into SMS text messaging communication
integer
Boolean to describe whether the user has opted into email communication
string
Critical note to provide context for Latchel operations response
integer
Unique ID for user role
array
A list of available times the resident has indicated availability
integer
default:"null"
The resident’s PropertyWare ID (if exists)
string
default:"null"
URL for the resident’s avatar
string
default:"null"
Tenant’s reference user ID
integer
Boolean to describe whether the user is active in Latchel or not
integer
default:"null"
Unique ID for PM Company who manages this resident
integer
default:"null"
Unique ID for resident’s Stripe account
integer
default:"null"
Status of resident’s Stripe account
json
default:"null"
Data corresponding to resident’s third party integrations
string
A human-readable unique identifier for the resident

Response

Return a 200 status to indicate that the data was received successfully
Last modified on May 12, 2026