Leads

Create lead

POST
https://api.propexo.com/v1/leads
Create a lead for an integration.

Request

This endpoint expects an object.
integration_id
string
last_name
optional string
The last name associated with the lead
first_name
optional string
The first name associated with the lead
email_1
optional string
The primary email address associated with the lead
phone_1
optional string
'Primary phone number associated with the lead. Defaults to the HOME phone type
phone_1_type
optional enum
Type of the primary phone number
Allowed values: HOMEWORKMOBILEFAX
phone_2
optional string
'Secondary phone number associated with the lead. Defaults to the MOBILE phone type
phone_2_type
optional enum
Type of the secondary phone number
Allowed values: HOMEWORKMOBILEFAX
address_1
optional string
The first address line associated with the lead
address_2
optional string
The second address line associated with the lead
city
optional string
The city associated with the lead
state
optional string
The state associated with the lead
zip
optional string
The zip code associated with the lead
country
optional string
The country associated with the lead
lead_source
optional string
The name of the source of the lead
property_id
optional string
The Propexo unique identifier for the property
x_lead_source_id
optional string
The external ID of the lead source from the integration vendor
middle_name
optional string
The middle name associated with the lead
date_of_birth
optional datetime
The date of birth associated with the lead
notes
optional string
Notes associated with the lead

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/leads
curl -X POST https://api.propexo.com/v1/leads \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"integration_id": "integration_id"
}'
Response
{
"job_id": "job_id",
"data": {}
}