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

​
Body

integration_idrequired
string
property_id
string

The Propify unique identifier for the property

unit_id
string

The Propify unique identifier for the unit

originating_lead_source_id
string

The ID of the lead source. This maps to the originatingLeadSourceId property of the Application object.

application_status
string

The status of the applicant's application either COMPLETED or APPROVED

Available options:
COMPLETED,
APPROVED
first_name
string

The last name associated with the applicant

last_name
string

The last name associated with the applicant

lease_term_in_months
integer

The amount of months for the lease term.

Available options:
3,
6,
9,
12,
15,
18
floorplan_id
string

The ID of the Floorplan in the PMS

move_in_date
string

The move-in date associated with the applicant

leasing_agent_id
string

The PMS ID of the leasing agent for this applicant

email_1
string

The primary email address associated with the applicant

date_of_birth
string

The date of birth associated with the applicant

address_1
string

The first address line associated with the applicant

address_2
string

Second line of the street address for the applicant. This maps to the addressLine2 property of the Applicant's primary address.

city
string

The city associated with the applicant

state
string

The state associated with the applicant

zip
string

The zip code associated with the applicant

phone_1
string

'Primary phone number associated with the applicant

attachments
array

Files to upload to the applicant.

events
array

Array of events associated with this applicant

custom_data
object

Custom data

send_rental_application_email
Default: false
boolean

Whether to send the new applicant an email with a link to the online application form. Defaults to FALSE.

x_unit_id
string

The unit ID to associate the applicant with

phone_1_type
string

Type of the primary phone number

Available options:
HOME,
MOBILE,
WORK
phone_2
string

'Secondary phone number associated with the applicant

phone_2_type
string

Type of the secondary phone number

Available options:
HOME,
MOBILE,
WORK
x_property_id
string

The property ID with which to associate the resident. This is the ID of the object in the PMS. Note that it should be passed as a string and not an integer.

middle_name
string

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

lead_id
string

The Propify unique identifier for the lead

application_date
string

The end date associated with the lease

start_date
string

The start date associated with the lease

end_date
string

The end date associated with the lease

status
string

The status associated with the lease

Available options:
PENDING,
APPROVED,
CANCELED,
DENIED,
SIGNED
rent_amount_market_in_cents
number

The market rent amount in cents for the applicant

​
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.