Residents

Create resident

POST
Create a resident for an integration.

Request

This endpoint expects an object.
integration_id
stringRequired
last_name
stringOptional
The last name of the resident. This value maps to both the LastName and PrimaryContact.LastName properties of the Tenant object
first_name
stringOptional
The first name of the resident. This value maps to both the FirstName and PrimaryContact.FirstName properties of the Tenant object
email_1
stringOptional
The primary email address for the resident. This value maps to the PrimaryContact.Email property of the Tenant object
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
Second line of the street address for the resident. This maps to the address2 property of the Contact object
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 address. This maps to the country property of the Contact object
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
Notes about the resident
phone_1
stringOptional

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
enumOptional
The type of the primary phone. Must be one of 'HOME', 'MOBILE', 'WORK', or 'FAX'
Allowed values: HOMEMOBILEWORKFAX
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
property_id
stringOptional
The Propexo unique identifier for the property
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
attachments
list of objectsOptional
Attachment files for user defined fields on the resident. All the files can have a maximum combined file size of 50 MB

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.
POST
1curl -X POST https://api.propexo.com/v1/residents \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "integration_id": "integration_id"
6}'
200Successful
1{
2 "job_id": "clwh5uics000608me9v74du0a",
3 "data": {}
4}