{
  "job_id": "string",
  "data": {}
}

​
Path Parameters

idrequired
string

The ID of the resource.

idrequired
string

The ID of the resource.

​
Body

idrequired
string
last_name
string

The last name of the resident. This value maps to the lastName property of the Contact object

first_name
string

The first name of the resident. This value maps to the firstName property of the Contact object

email_1
string

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

email_2
string

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

date_of_birth
string

The date of birth of the resident. This value maps to the birthDate property of the Contact object.

address_1
string

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

address_2
string

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

city
string

City of the resident's address. This maps to the city property of the Contact object.

state
string

State of the resident's address. This maps to the state property of the Contact object.

zip
string

Zip/Postal Code of the resident's address. This maps to the zip property of the Contact object.

country
string

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

address_1_alternate
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
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
string

City of the resident's secondary/alternate address

state_alternate
string

State of the resident's secondary/alternate address

zip_alternate
string

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

country_alternate
string

Country of the resident's secondary/alternate address.

Available options:
US
notes
string

Any notes about the resident. This maps to the comments property of the Contact object

phone_1
string

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
string

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

Available options:
HOME,
MOBILE,
WORK,
FAX
phone_2
string

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
string

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

Available options:
HOME,
MOBILE,
WORK,
FAX
custom_data
object

Custom data

middle_name
string

The middle name of the resident. This value maps to the middleName property of the Contact object

events
array

Array of events associated with this resident.

resident_id
string

The Propify unique identifier for the resident

rent_period
string

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.

Available options:
monthly,
weekly,
daily
rent_due_day
integer

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

​
Response

job_idrequired
string

The ID of the job created to handle this operation

datarequired
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.