Request This endpoint expects an object.
integration_id string Required
The Propexo unique identifier for the integration
property_id string Required
The Propexo unique identifier for the property
unit_id string Required
The Propexo unique identifier for the unit
lead_id string Optional
The Propexo unique identifier for the lead. The lead will be converted to an applicant
employee_id string Optional
The Propexo unique identifier for the employee. Employee must have a role of LEASING_AGENT. Required if lead_id is not specified
lead_source_id string Optional
The Propexo unique identifier for the lead source. Required if lead_id is not specified
third_party_id string Optional >=1 character
A unique ID you would like to associate with the applicant. This is not the Yardi applicant ID. Required if lead_id is not specified
organization_name string Optional
The name of your organization. Yardi uses this for associating an applicant. Required if lead_id is not specified
first_name string Optional
The first name associated with the applicant. Required if lead_id is not specified
last_name string Optional
The last name associated with the applicant. Required if lead_id is not specified
middle_name string Optional
The middle name associated with the applicant
maiden_name string Optional
The maiden name associated with the applicant
email_1 string Optional format: "email"
The primary email address associated with the applicant
phone_1 string Optional format: "^\d{10}$"
Primary phone number associated with the applicant
phone_1_type enum Optional
Type of the primary phone number
Allowed values: FAX HOME MOBILE WORK
phone_2 string Optional format: "^\d{10}$"
Secondary phone number associated with the applicant
phone_2_type enum Optional
Type of the secondary phone number
Allowed values: FAX HOME MOBILE WORK
move_in_date string Optional
The desired move-in date to the unit listed in the application
move_out_date string Optional
The desired move-out date to the unit listed in the application
desired_lease_term_in_months string Optional
The desired lease term in months of the applicant
date_of_birth string Optional
The date of birth associated with the applicant
notes string Optional
Notes associated with the applicant
is_evicted boolean Optional
Whether the applicant has been evicted
is_felony boolean Optional
Whether the applicant has a felony
is_criminal_charge boolean Optional
Whether the applicant has a criminal charge
eviction_description string Optional
The description of the eviction
felony_description string Optional
The description of the felony
criminal_charge_description string Optional
The description of the criminal charge
marital_status enum Optional
The marital status of the applicant
Allowed values: SINGLE MARRIED
identification_number string Optional
The social security number of the applicant
drivers_license_number string Optional
The driver's license number of the applicant
address_history list of objects Optional
The address history of the applicant. Note: This will only be added to the primary applicant on the application.
emergency_contacts list of objects Optional
A list of emergency contacts for the applicant. Note: This will only be added to the primary applicant on the application.
employment_history list of objects Optional
The employment history of the applicant. Note: This will only be added to the primary applicant on the application.
other_income list of objects Optional
A list of other income sources for the applicant. Note: This will only be added to the primary applicant on the application.
vehicles list of objects Optional
A list of vehicles for the application. Note: This will only be added to the primary applicant on the application.
pets list of objects Optional
A list of applicant pets. Note: This will only be added to the primary applicant on the application.
concession_fees list of objects Optional
A list of concession fees for the application
application_fees list of objects Optional
A list of application fees for the application
other_occupants list of objects Optional
A list of other occupants for the application
