Applicants

Update applicant

PUT
https://api.propexo.com/v1/applicants/:id
Update an applicant for an integration.

Path parameters

id
string

Request

This endpoint expects an object.
last_name
optional string
The last name associated with the applicant
first_name
optional string
The first name associated with the applicant
x_unit_id
optional string
Deprecated: The external ID of the unit from the integration vendor
email_1
optional string
The primary email address associated with the applicant
phone_1
optional string
'Primary phone number associated with the applicant
phone_1_type
optional enum
Type of the primary phone number
Allowed values: HOMEMOBILEWORK
phone_2
optional string
'Secondary phone number associated with the applicant
phone_2_type
optional enum
Type of the secondary phone number
Allowed values: HOMEMOBILEWORK
applicant_id
optional string
The Propexo unique identifier for the applicant
application_id
optional string
The Propexo unique identifier for the application
unit_id
optional string
The Propexo unique identifier for the unit
property_id
optional string
The Propexo unique identifier for the property
originating_lead_source_id
optional string
The external ID of the lead source from the integration vendor
application_status
optional enum
The status associated with the application
Allowed values: COMPLETEDAPPROVED
date_of_birth
optional datetime
The date of birth associated with the applicant
address_1
optional string
The first address line associated with the applicant
address_2
optional string
The second address line associated with the applicant
city
optional string
The city associated with the applicant
move_in_date
optional datetime
The move-in date associated with the lease
state
optional string
The state associated with the applicant
zip
optional string
The zip code associated with the applicant
lease_term_in_months
optional integer
The amount of months for the lease term
leasing_agent_id
optional string
The external ID of the leasing agent from the integration vendor
floorplan_id
optional string
The external ID of the floor plan from the integration vendor
events
optional list of objects
Array of events associated with this applicant
create_new_events_only
optional union
Whether or not new events should be created on the applicant
x_property_id
optional string
The external ID of the property from the integration vendor
middle_name
optional string
The middle name associated with the applicant
country
optional string
The country associated with the applicant
application_date
optional datetime
The application date associated with the applicant
start_date
optional datetime
The start date associated with the applicant
end_date
optional datetime
The end date associated with the applicant
status
optional enum
The status associated with the applicant
Allowed values: PENDINGAPPROVEDCANCELEDDENIEDSIGNED
rent_amount_market_in_cents
optional integer
The market rent amount in cents for the lease

Response

This endpoint return an object.
job_id
string
The ID of the job created to handle this operation
data
object
Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.
PUT
/v1/applicants/:id
curl -X PUT https://api.propexo.com/v1/applicants/id \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{}'
Response
{
"job_id": "job_id",
"data": {}
}