Residents

Update resident

PUT
https://api.propexo.com/v1/residents/:id
Update a resident for an integration.

Path parameters

id
string

Request

This endpoint expects an object.
resident_id
optional string
The Propexo unique identifier for the resident
last_name
optional string
The last name of the resident. This value maps to the lastName property of the Contact object
first_name
optional string
The first name of the resident. This value maps to the firstName property of the Contact object
email_1
optional string
The primary email address for the resident. This value maps to the email property of the Contact object
email_2
optional string
The secondary email address for the resident. This value maps to the altEmail property of the Contact object
date_of_birth
optional datetime
The date of birth of the resident. This value maps to the birthDate property of the Contact object.
address_1
optional string
First line of the street address for the resident. This maps to the address property of Contact object
address_2
optional string
Second line of the street address for the resident. This maps to the address2 property of the Contact object
city
optional string
City of the resident's address. This maps to the city property of the Contact object.
state
optional string
State of the resident's address. This maps to the state property of the Contact object.
zip
optional string
Zip/Postal Code of the resident's address. This maps to the zip property of the Contact object.
country
optional string
Country of the resident's address. This maps to the country property of the Contact object
address_1_alternate
optional string
Secondary/alternate street address for the resident. This maps to the Street property of the second address of the Tenant object
address_2_alternate
optional string
Second line of the secondary/alternate street address for the resident. This maps to the AlternateAddress.AddressLine2 property of the Tenant object
city_alternate
optional string
City of the resident's secondary/alternate address
state_alternate
optional string
State of the resident's secondary/alternate address
zip_alternate
optional string
Zip/Postal Code of the resident's secondary/alternate address
country_alternate
optional "US"
notes
optional string
Any notes about the resident. This maps to the comments property of the Contact object
phone_1
optional string
Primary 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_1_type
optional enum
The type of the primary phone. Must be one of 'HOME', 'MOBILE', 'WORK', or 'FAX'
Allowed values: HOMEMOBILEWORKFAX
phone_2
optional string
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
optional enum
The type of the secondary phone. Must be one of 'HOME', 'MOBILE', 'WORK', or 'FAX'
Allowed values: HOMEMOBILEWORKFAX
custom_data
optional object
Deprecated: Field is no longer applicable
middle_name
optional string
The middle name of the resident. This value maps to the middleName property of the Contact object
events
optional list of objects
Array of events associated with this resident.
rent_period
optional enum
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
optional integer
Day of the month on which the tenant's rent is due. Maps to the RentDueDay property of the Tenant object

Response

This endpoint return 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.
PUT
/v1/residents/:id
curl -X PUT https://api.propexo.com/v1/residents/id \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{}'
Response
{
"job_id": "job_id",
"data": {}
}