Applicants

Create applicant

POST
Create an applicant for an integration.

Request

This endpoint expects an object.
integration_id
stringRequired
unit_id
stringOptional
The Propexo unique identifier for the unit
first_name
stringOptional
The first name associated with the applicant
last_name
stringOptional
The last name associated with the applicant
send_rental_application_email
booleanOptional
Whether to send the new applicant an email with a link to the online application form
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
custom_data
objectOptional
Deprecated: Field is no longer applicable
property_id
stringOptional
The Propexo unique identifier for the property
lease_period_id
stringOptional
The Propexo unique identifier for the lease period
lead_source_id
stringOptional
The Propexo unique identifier for the lead source
address_1
stringOptional
The first address line associated with the applicant
application_status
enumOptional
The status associated with the application
Allowed values: COMPLETEDAPPROVED
city
stringOptional
The city associated with the applicant
state
stringOptional
The state associated with the applicant
zip
stringOptional
The zip code associated with the applicant
address_2
stringOptional
The second address line associated with the applicant
attachments
list of objectsOptional
Files to upload for 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
middle_name
stringOptional
The middle name associated with the applicant
lead_id
stringOptional
The Propexo unique identifier for the lead
application_date
datetimeOptional
The application date associated with the applicant
start_date
datetimeOptional
The start date associated with the lease
end_date
datetimeOptional
The end date associated with the lease
status
enumOptional
The status associated with the application
Allowed values: PENDINGAPPROVEDCANCELEDDENIEDSIGNED
rent_amount_market_in_cents
integerOptional
The market rent amount in cents for the lease
organization_name
stringOptional
The name of your organization. Other uses this for associating an applicant
unique_applicant_id
stringOptional
A unique ID you associate with a applicant. This is not the Other applicant ID.
target_move_in_date
unionOptional
The target move in date for the applicant. The timestamp will be stripped off and only the date will be used
desired_num_bedrooms
doubleOptional
The desired number of bedrooms of the applicant
desired_lease_term_in_months
stringOptional
The desired lease term in months of the applicant
notes
stringOptional
Notes associated with the applicant
leasing_agent
stringOptional
The full name of the leasing agent associated with the applicant
lead_source
stringOptional
The name of the lead source 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.
POST
1curl -X POST https://api.propexo.com/v1/applicants \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "integration_id": "integration_id"
6}'
200Successful
1{
2 "job_id": "clwh5uics000608me9v74du0a",
3 "data": {}
4}