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

Body

integration_idrequired
string
last_name
string

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

first_name
string

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

email_1
string

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

email_2
string

An alternate email address for the resident. This value maps to the AlternateEmail property of the Tenant object.

date_of_birth
string

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

address_1
string

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

address_2
string

Second line of the street address for the resident. This maps to the Address.AddressLine2 property of the Tenant object.

city
string

City of the resident's primary address

state
string

State of the resident's primary address

zip
string

Zip/Postal Code of the resident's primary address

country
string

Country of the resident's primary address.

Available options:
US
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

Notes about the resident

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

The type of the resident's primary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'.

Available options:
HOME,
WORK,
MOBILE,
FAX
phone_2
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
string

The type of the resident's secondary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'.

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

Custom data

property_id
string

The Propify unique identifier for the property

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

middle_name
string

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

attachments
array

Attachment files for user defined fields on the resident

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.