Residents

Update resident

PUT
Update a resident for an integration.

Path parameters

idstringRequired

Request

This endpoint expects an object.
resident_id
stringOptional
The Propexo unique identifier for the resident
last_name
stringOptional
The last name of the resident.
first_name
stringOptional
The first name of the resident.
email_1
stringOptional
The primary email address for the resident.
email_2
stringOptional
The secondary email address for the resident. This value maps to the altEmail property of the Contact object
date_of_birth
datetimeOptional
The date of birth of the resident. This value maps to the PrimaryContact.DateOfBirth property of the Tenant object.
address_1
stringOptional
Street address for the resident. This maps to the Street property of the primary address of the Tenant object
address_2
stringOptional
Street address for the resident.
city
stringOptional
City of the resident's primary address
state
stringOptional
State of the resident's primary address
zip
stringOptional
Zip/Postal Code of the resident's primary address
country
stringOptional
Country of the resident's primary address
address_1_alternate
stringOptional
Secondary/alternate street address for the resident. This maps to the Street property of the second address of the Tenant object
address_2_alternate
stringOptional
Second line of the secondary/alternate street address for the resident. This maps to the AlternateAddress.AddressLine2 property of the Tenant object
city_alternate
stringOptional
City of the resident's secondary/alternate address
state_alternate
stringOptional
State of the resident's secondary/alternate address
zip_alternate
stringOptional
Zip/Postal Code of the resident's secondary/alternate address
country_alternate
"US"Optional
Country of the resident's secondary/alternate address.
notes
stringOptional
Any notes about the resident. This maps to the comments property of the Contact object
phone_1
stringOptional
The primary phone number for the resident.
phone_1_type
enumOptional
The primary phone type for the resident. Required when updating phone number.
Allowed values: HOMEWORKMOBILEFAX
phone_2
stringOptional

Secondary phone number for the resident. Depending on the value of phone_1_type, this may map to the properties fax, homePhone, mobilePhone, or workPhone.

phone_2_type
enumOptional
The type of the secondary phone. Must be one of 'HOME', 'MOBILE', 'WORK', or 'FAX'
Allowed values: HOMEMOBILEWORKFAX
custom_data
objectOptional
Deprecated: Field is no longer applicable
middle_name
stringOptional
The middle name of the resident. This value maps to the PrimaryContact.MiddleName property of the Tenant object
events
list of objectsOptional
DEPRECATED: Please use /events endpoints to write events. Array of events associated with this resident
rent_period
enumOptional
How often the resident is expected to pay rent. Allowed values are "monthly", "weekly", and "daily". Maps to the RentPeriod property of the Tenant object.
Allowed values: monthlyweeklydaily
rent_due_day
integerOptional
Day of the month on which the tenant's rent is due. Maps to the RentDueDay property of the Tenant object

Response

This endpoint returns an object
job_id
string
The ID of the job created to handle this operation
data
object
Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.