Create resident

POST
/v1/residents/

Create a resident for an integration.

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_1stringOptional

The primary email address for the resident. This value maps to the PrimaryContact.Email property of the Tenant object

email_2stringOptional

The secondary email address for the resident. This value maps to the altEmail property of the Contact object

date_of_birthdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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

Second line of the street address for the resident. This maps to the address2 property of the Contact object

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

countrystringOptional

Country of the resident’s address. This maps to the country property of the Contact object

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_alternate"US"OptionalDefaults to US

Country of the resident’s secondary/alternate address.

notesstringOptional

Notes about the resident

phone_1stringOptional

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_typeenumOptional
Allowed values: HOMEMOBILEWORKFAX

The type of the primary phone. Must be one of ‘HOME’, ‘MOBILE’, ‘WORK’, or ‘FAX’

phone_2stringOptional

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_typeenumOptional
Allowed values: HOMEMOBILEWORKFAX

The type of the secondary phone. Must be one of ‘HOME’, ‘MOBILE’, ‘WORK’, or ‘FAX’

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
Allowed values: MONTHLYWEEKLYDAILY

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.

rent_due_dayintegerOptional>=1<=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

Built with