API ReferenceApplications

Update Application

Update an Application for an Integration.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

idstringRequired
The Propexo unique identifier for the application

Request

This endpoint expects an object.
applicant_idstringOptional
The Propexo unique identifier for the applicant
application_idstringOptional
The Propexo unique identifier for the application
lease_period_idstringOptional
The Propexo unique identifier for the lease period
unit_idstringOptional
The Propexo unique identifier for the unit for this application
lead_source_idstringOptional
The Propexo unique identifier for the lead source
address_1stringOptional
The first address line associated with the applicant
address_2stringOptional
The second address line associated with the applicant
application_statusenumOptional
The status associated with the application
Allowed values:
attachmentslist of objectsOptional
Files to upload for the applicant. All the files can have a maximum combined file size of 50 MB
citystringOptional
The city associated with the applicant
create_new_events_onlyboolean or stringOptional
Whether or not new events should be created on the applicant
date_of_birthstringOptional
The date of birth associated with the applicant
email_1stringOptionalformat: "email"
The primary email address associated with the applicant
first_namestringOptional
The first name associated with the applicant
last_namestringOptional
The last name associated with the applicant
move_in_datestringOptional

The desired move-in date to the unit listed in the application

phone_1_typeenumOptional
Type of the primary phone number
Allowed values:
phone_1stringOptionalformat: "^\d{10}$"
Primary phone number associated with the applicant
statestringOptional
The state associated with the applicant
zipstringOptional
The zip code associated with the applicant
petslist of objectsOptional
A list of applicant pets. If any pets are provided, this list will overwrite the existing list of pets
vehicleslist of objectsOptional
A list of vehicles for the application
employment_historylist of objectsOptional
The employment history of the applicant
add_onslist of objectsOptional

Add-ons of the applicant

employee_idstring or nullOptional
The Propexo unique identifier for the employee who is assigned to process this application, or none to be assigned to nobody
application_status_idstringOptional
The Propexo unique identifier for the application status for this application
middle_namestringOptional
The middle name associated with the applicant
maiden_namestringOptional
The maiden name associated with the applicant
phone_2stringOptionalformat: "^\d{10}$"
Secondary phone number associated with the applicant
phone_2_typeenumOptional
Type of the secondary phone number
Allowed values:
move_out_datestringOptional

The desired move-out date to the unit listed in the application

desired_lease_term_in_monthsstringOptional
The desired lease term in months of the applicant
notesstringOptional
Notes associated with the applicant
is_evictedbooleanOptional
Whether the applicant has been evicted
is_felonybooleanOptional
Whether the applicant has a felony
is_criminal_chargebooleanOptional
Whether the applicant has a criminal charge
eviction_descriptionstringOptional
The description of the eviction
felony_descriptionstringOptional
The description of the felony
criminal_charge_descriptionstringOptional
The description of the criminal charge
marital_statusenumOptional
The marital status of the applicant
Allowed values:
identification_numberstringOptional
The social security number of the applicant
drivers_license_numberstringOptional
The driver's license number of the applicant
address_historylist of objectsOptional
The address history of the applicant
emergency_contactslist of objectsOptional
A list of emergency contacts for the applicant
other_incomelist of objectsOptional
A list of other income sources for the applicant
concession_feeslist of objectsOptional
A list of concession fees for the application
application_feeslist of objectsOptional
A list of application fees for the application. Only new application fees should be passed in, existing fees cannot be updated
other_occupantslist of objectsOptional
A list of other occupants for the application. Only new occupants should be passed in, existing occupants cannot be updated
eventslist of objectsOptionalDeprecated

DEPRECATED: Please use /events endpoints to write events. Array of events associated with this applicant

Response

Successful response
job_idstring
The ID of the job created to handle this operation
dataobject

Errors