Residents

Create resident

Create a resident for an integration.

post/v1/residents/

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/residents/
  • Auth: HTTP bearer

Request body

integration_idstring required
lease_idstring

The Propexo unique identifier for the lease

last_namestring

The last name of the resident. This value maps to both the LastName and PrimaryContact.LastName properties of the Tenant object

first_namestring

The first name of the resident. This value maps to both the FirstName and PrimaryContact.FirstName properties of the Tenant object

email_1string email

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

email_2string email

The secondary email address associated with the resident

date_of_birthstring date-time

The date of birth of the resident. This value maps to the PrimaryContact.DateOfBirth property of the Tenant object.

address_1string

Street address for the resident. This maps to the Street property of the primary address of the Tenant object

address_2string

The second address line associated with the resident

citystring

City of the resident's primary address

statestring

State of the resident's primary address

zipstring

Zip/Postal Code of the resident's primary address

address_1_alternatestring

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

address_2_alternatestring

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

city_alternatestring

City of the resident's secondary/alternate address

state_alternatestring

State of the resident's secondary/alternate address

zip_alternatestring

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

country_alternate'US'

Country of the resident's secondary/alternate address.

notesstring

Notes about the resident

phone_1string

Primary phone number associated with the resident

phone_1_type'FAX' | 'HOME' | 'MOBILE' | 'OTHER' | 'WORK'

Type of the primary phone number

phone_2string

Secondary phone number associated with the resident

phone_2_type'FAX' | 'HOME' | 'MOBILE' | 'OTHER' | 'WORK'

Type of the secondary phone number

custom_dataV1ResidentsPostInputCustomData

Deprecated: Field is no longer applicable

middle_namestring

The middle name of the resident. This value maps to the PrimaryContact.MiddleName property of the Tenant object

property_idstring

The Propexo unique identifier for the property

rent_period'MONTHLY' | 'WEEKLY' | 'DAILY'

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_dayinteger

Day of the month on which the tenant's rent is due. Maps to the RentDueDay property of the Tenant object

Response

Successful response

job_idstring required

The ID of the job created to handle this operation

dataV1ResidentsPostOutputData required

Changes

No recorded changes to this operation across all 1 revision of this API.