API ReferenceResidents

Create resident

Create a resident for an integration.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
integration_idstringRequired
lease_idstringOptional
The Propexo unique identifier for the lease
last_namestringOptional
The last name of the resident. This value maps to both the LastName and PrimaryContact.LastName properties of the Tenant object
first_namestringOptional
The first name of the resident. This value maps to both the FirstName and PrimaryContact.FirstName properties of the Tenant object
email_1stringOptionalformat: "email"
The primary email address for the resident. This value maps to the PrimaryContact.Email property of the Tenant object
email_2stringOptionalformat: "email"
The secondary email address associated with the resident
date_of_birthstringOptionalformat: "date-time"
The date of birth of the resident. This value maps to the PrimaryContact.DateOfBirth property of the Tenant object.
address_1stringOptional
Street address for the resident. This maps to the Street property of the primary address of the Tenant object
address_2stringOptional
The second address line associated with the resident
citystringOptional
City of the resident's primary address
statestringOptional
State of the resident's primary address
zipstringOptional

Zip/Postal Code of the resident’s primary address

countryenum or stringOptional
The country associated with the resident
address_1_alternatestringOptional

Secondary/alternate street address for the resident. This maps to the Street property of the second address of the Tenant object

address_2_alternatestringOptional

Second line of the secondary/alternate street address for the resident. This maps to the AlternateAddress.AddressLine2 property of the Tenant object

city_alternatestringOptional

City of the resident’s secondary/alternate address

state_alternatestringOptional

State of the resident’s secondary/alternate address

zip_alternatestringOptional

Zip/Postal Code of the resident’s secondary/alternate address

country_alternateenumOptional

Country of the resident’s secondary/alternate address.

Allowed values:
notesstringOptional
Notes about the resident
phone_1stringOptional
Primary phone number associated with the resident
phone_1_typeenumOptional
Type of the primary phone number
Allowed values:
phone_2stringOptional
Secondary phone number associated with the resident
phone_2_typeenumOptional
Type of the secondary phone number
Allowed values:
middle_namestringOptional
The middle name of the resident. This value maps to the PrimaryContact.MiddleName property of the Tenant object
property_idstringOptional
The Propexo unique identifier for the property
rent_periodenumOptional
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:
rent_due_dayintegerOptional1-31
Day of the month on which the tenant's rent is due. Maps to the RentDueDay property of the Tenant object
attachmentslist of objectsOptional
Attachment files for user defined fields on the resident. All the files can have a maximum combined file size of 50 MB
custom_dataobjectOptionalDeprecated

Deprecated: Field is no longer applicable

Response

Successful response
job_idstring
The ID of the job created to handle this operation
dataobject

Errors