Update Application

PUT
/v1/applications/:id
Update an Application for an Integration.

Path parameters

idstringRequired
The Propexo unique identifier for the application

Request

This endpoint expects an object.
application_idstringOptional
The Propexo unique identifier for the application
unit_idstringOptional
The Propexo unique identifier for the unit for this application
employee_idstringOptional
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
applicant_idstringOptional
The Propexo unique identifier for the applicant
first_namestringOptional
The first name associated with the applicant
last_namestringOptional
The last name associated with the applicant
middle_namestringOptional
The middle name associated with the applicant
maiden_namestringOptional
The maiden name associated with the applicant
email_1stringOptional
The primary email address associated with the applicant
phone_1stringOptional
Primary phone number associated with the applicant
phone_1_typeenumOptional
Allowed values: FAXHOMEMOBILEWORK
Type of the primary phone number
phone_2stringOptional
Secondary phone number associated with the applicant
phone_2_typeenumOptional
Allowed values: FAXHOMEMOBILEWORK
Type of the secondary phone number
move_in_datedatetime or stringOptional
The desired move-in date to the unit listed in the application
move_out_datedatetime or stringOptional
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
date_of_birthdatetime or stringOptional
The date of birth associated with 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_status"SINGLE" or "MARRIED"Optional
Allowed values: SINGLEMARRIED
The marital status of the applicant
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
employment_historylist of objectsOptional
The employment history of the applicant
other_incomelist of objectsOptional
A list of other income sources for the applicant
vehicleslist of objectsOptional
A list of vehicles for the application
petslist of objectsOptional
A list of applicant pets. If any pets are provided, this list will overwrite the existing list of pets
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

Response

This endpoint returns an object.
job_idstring
The ID of the job created to handle this operation
dataobject

Errors