Applicants

Create applicant

POST
https://api.propexo.com/v1/applicants
Create an applicant for an integration.

Request

This endpoint expects an object.
integration_id
string
property_id
optional string
The Propexo unique identifier for the property
unit_id
optional string
The Propexo unique identifier for the unit
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
first_name
optional string
The first name associated with the applicant
last_name
optional string
The last name associated with the applicant
lease_term_in_months
optional integer
The amount of months for the lease term
floorplan_id
optional string
The external ID of the floor plan from the integration vendor
move_in_date
optional datetime
The move-in date associated with the lease
leasing_agent_id
optional string
The external ID of the leasing agent from the integration vendor
email_1
optional string
The primary email address associated with the applicant
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
Second line of the street address for the applicant. This maps to the addressLine2 property of the Applicant's primary address.
city
optional string
The city associated with the applicant
state
optional string
The state associated with the applicant
zip
optional string
The zip code associated with the applicant
phone_1
optional string
'Primary phone number associated with the applicant
attachments
optional list of objects
Files to upload to the applicant.
events
optional list of objects
Array of events associated with this applicant
custom_data
optional object
Deprecated: Field is no longer applicable
send_rental_application_email
optional boolean
Whether to send the new applicant an email with a link to the online application form
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
middle_name
optional string
The middle name associated with the applicant
lead_id
optional string
The Propexo unique identifier for the lead
application_date
optional datetime
The application date associated with the applicant
start_date
optional datetime
The start date associated with the lease
end_date
optional datetime
The end date associated with the lease
status
optional enum
The status associated with the application
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.
POST
/v1/applicants
curl -X POST https://api.propexo.com/v1/applicants \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"integration_id": "integration_id"
}'
Response
{
"job_id": "job_id",
"data": {}
}