Leads

Create lead

POST
Create a lead for an integration.

Request

This endpoint expects an object.
integration_id
stringRequired
property_id
stringOptional
The Propexo unique identifier for the property
lead_source_id
stringOptional
The Propexo unique identifier for the lead source
unit_id
stringOptional
The Propexo unique identifier for the unit
lease_period_id
stringOptional
The Propexo unique identifier for the lease period
first_name
stringOptional
The first name associated with the lead
last_name
stringOptional
The last name associated with the lead
phone_1
stringOptional
Primary phone number associated with the lead
phone_1_type
enumOptional
Type of the primary phone number
Allowed values: FAXHOMEMOBILEWORK
middle_name
stringOptional
The middle name associated with the lead
phone_2
stringOptional
Secondary phone number associated with the lead
phone_2_type
enumOptional
Type of the secondary phone number
Allowed values: FAXHOMEMOBILEWORK
email_1
stringOptional
The primary email address associated with the lead
address_1
stringOptional
The first address line associated with the lead
address_2
stringOptional
The second address line associated with the lead
city
stringOptional
The city associated with the lead
state
stringOptional
The state associated with the lead
zip
stringOptional
The zip code associated with the lead
target_move_in_date
unionOptional
The move-in date associated with the lead. The timestamp will be stripped off and only the date will be used
desired_max_rent_in_cents
integerOptional
The maximum rent cost the lead is looking to pay, in cents
desired_min_rent_in_cents
doubleOptional
The minimum rent cost the lead is looking to pay, in cents
desired_num_bathrooms
doubleOptional
The desired number of bathrooms
desired_num_bedrooms
doubleOptional
The desired number of bedrooms
number_of_occupants
integerOptional
The number of occupants living in the unit
notes
stringOptional
Notes associated with the lead
events
list of objectsOptional
DEPRECATED: Please use /events endpoints to write events. Array of events associated with this lead
country
stringOptional
The country associated with the lead
status_raw
stringOptional
The raw status associated with the lead
desired_unit_type
stringOptional
The desired type of unit
lead_relationship_id
stringOptional
The Propexo unique identifier for the lead relationship
date_of_birth
unionOptional
The date of birth associated with the lead
employee_id
stringOptional
The Propexo unique identifier for the employee
desired_lease_term_in_months
stringOptional
The amount of months for the lease term
organization_name
stringOptional
The name of your organization. Other uses this for associating a prospect
third_party_id
stringOptional
Any unique ID you would like to associate with a lead.

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.
Built with