Applicants

Update applicant

PUT
Update an applicant for an integration.

Path parameters

idstringRequired

Request

This endpoint expects an object.
last_name
stringOptional
The last name associated with the applicant
first_name
stringOptional
The first name associated with the applicant
x_unit_id
stringOptional
Deprecated: The external ID of the unit from the integration vendor
email_1
stringOptional
The primary email address associated with the applicant
phone_1
stringOptional
Primary phone number associated with the applicant
phone_1_type
enumOptional
Type of the primary phone number
Allowed values: FAXHOMEMOBILEWORK
phone_2
stringOptional
Secondary phone number associated with the applicant
phone_2_type
enumOptional
Type of the secondary phone number
Allowed values: FAXHOMEMOBILEOTHERWORK
applicant_id
stringOptional
The Propexo unique identifier for the applicant
application_id
stringOptional
The Propexo unique identifier for the application
lease_period_id
stringOptional
The Propexo unique identifier for the lease period
unit_id
stringOptional
The Propexo unique identifier for the unit
lead_source_id
stringOptional
The Propexo unique identifier for the lead source
address_1
stringOptional
The first address line associated with the applicant
address_2
stringOptional
The second address line associated with the applicant
application_status
enumOptional
The status associated with the application
Allowed values: COMPLETEDAPPROVED
attachments
list of objectsOptional
Files to upload for the applicant. All the files can have a maximum combined file size of 50 MB
city
stringOptional
The city associated with the applicant
create_new_events_only
unionOptional
Whether or not new events should be created on the applicant
date_of_birth
datetimeOptional
The date of birth associated with the applicant
events
list of objectsOptional
DEPRECATED: Please use /events endpoints to write events. Array of events associated with this applicant
move_in_date
datetimeOptional
The move-in date associated with the lease
state
stringOptional
The state associated with the applicant
zip
stringOptional
The zip code associated with the applicant
middle_name
stringOptional
The middle name associated with the applicant
country
stringOptional
The country associated with the applicant
x_property_id
stringOptional
The external ID of the property from the integration vendor
application_date
datetimeOptional
The application date associated with the applicant
start_date
datetimeOptional
The start date associated with the applicant
end_date
datetimeOptional
The end date associated with the applicant
status
enumOptional
The status associated with the applicant
Allowed values: PENDINGAPPROVEDCANCELEDDENIEDSIGNED
rent_amount_market_in_cents
integerOptional
The market rent amount in cents for the lease
notes
stringOptional
Notes associated with the applicant

Response

This endpoint returns 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
1curl -X PUT https://api.propexo.com/v1/applicants/id \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Updated
1{
2 "job_id": "clwh5uics000608me9v74du0a",
3 "data": {}
4}