Leads

Update lead

PUT
https://api.propexo.com/v1/leads/:id
Update a lead.

Path parameters

id
string

Request

This endpoint expects an object.
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
phone_1_type
optional enum
Type of the primary phone number
Allowed values: FAXHOMEMOBILEOTHERWORK
phone_2
optional string
'Secondary phone number associated with the lead
phone_2_type
optional enum
Type of the secondary phone number
Allowed values: FAXHOMEMOBILEOTHERWORK
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
lead_id
optional string
The Propexo unique identifier for the lead
property_id
optional string
The Propexo unique identifier for the property
unit_id
optional string
The Propexo unique identifier for the unit
x_leasing_agent_id
optional string
The external ID of the leasing agent from the integration vendor
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
desired_lease_term_in_months
optional string
The amount of months for the lease term
target_move_in_date
optional string
The move-in date associated with the lead
desired_num_bedrooms
optional double
The desired number of bedrooms
desired_num_bathrooms
optional double
The desired number of bathrooms
desired_floor_plan_id
optional string
The external ID of the floor plan from the integration vendor
desired_max_rent_in_cents
optional double
The maximum rent cost the lead is looking to pay, in cents
desired_min_rent_in_cents
optional double
The minimum rent cost the lead is looking to pay, in cents
number_of_occupants
optional double
The number of occupants living in the unit
notes
optional string
Notes associated with the lead
events
optional list of objects
Array of events associated with this lead
desired_unit_number
optional string
The desired unit number
status
optional string
The status associated with the lead
desired_unit_type
optional string
The desired type of unit

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