{
  "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 associated with the applicant

first_name
string

The last name associated with the applicant

x_unit_id
string

The unit ID to associate the applicant with

email_1
string

The primary email address associated with the applicant

phone_1
string

'Primary phone number associated with the applicant

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

The Propify unique identifier for the applicant

application_id
string

The Propify unique identifier for the application

unit_id
string

The Propify unique identifier for the unit

property_id
string

The Propify unique identifier for the property

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

Street address for the applicant.

city
string

The city associated with the applicant

move_in_date
string

The move-in date associated with the applicant

state
string

The state associated with the applicant

zip
string

The zip code 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
leasing_agent_id
string

The PMS ID of the leasing agent for this applicant

floorplan_id
string

The ID of the Floorplan in the PMS

events
array

Array of events associated with this applicant

x_property_id
string

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

middle_name
string

The middle name of the applicant.

country
string

Country of the applicant's primary address

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.