Residents

Create resident

POST
https://api.propexo.com/v1/residents
Create a resident for an integration.

Request

This endpoint expects an object.
integration_id
string
last_name
optional string
The last name of the resident. This value maps to both the LastName and PrimaryContact.LastName properties of the Tenant object
first_name
optional string
The first name of the resident. This value maps to both the FirstName and PrimaryContact.FirstName properties of the Tenant object
email_1
optional string
The primary email address for the resident. This value maps to the PrimaryContact.Email property of the Tenant object
email_2
optional string
An alternate email address for the resident. This value maps to the AlternateEmail property of the Tenant object.
date_of_birth
optional datetime
The date of birth of the resident. This value maps to the PrimaryContact.DateOfBirth property of the Tenant object.
address_1
optional string
Street address for the resident. This maps to the Street property of the primary address of the Tenant object
address_2
optional string
Second line of the street address for the resident. This maps to the Address.AddressLine2 property of the Tenant object.
city
optional string
City of the resident's primary address
state
optional string
State of the resident's primary address
zip
optional string
Zip/Postal Code of the resident's primary address
country
optional "US"
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
Notes about the resident
phone_1
optional string
Resident's primary phone number. This will be assumed to be a HOME phone number unless phone_1_type is also set.
phone_1_type
optional enum
The type of the resident's primary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'.
Allowed values: HOMEWORKMOBILEFAX
phone_2
optional string
Resident's secondary phone number. This will be assumed to be a MOBILE phone number unless phone_2_type is also set.
phone_2_type
optional enum
The type of the resident's secondary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'.
Allowed values: HOMEWORKMOBILEFAX
custom_data
optional object
Deprecated: Field is no longer applicable
property_id
optional string
The Propexo unique identifier for the property
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
middle_name
optional string
The middle name of the resident. This value maps to the PrimaryContact.MiddleName property of the Tenant object
attachments
optional list of objects
Attachment files for user defined fields on the resident

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