Events

Create event for a lead

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

Request

This endpoint expects an object.
integration_id
string
lead_id
optional string
The Propexo unique identifier for the lead
event_name
optional enum
The name or type of event
event_datetime
optional datetime
The date when the event will occur
notes
optional string
Notes associated with the event
employee_id
optional string
The Propexo unique identifier for the employee
event_type_id
optional string
The Propexo unique identifier for the event type
unit_id
optional string
The Propexo unique identifier for the unit. Only some PMS events use this, including "Show" and "Appointment"
status
optional enum
The status associated with the event
Allowed values: LEASEDLOSTUNQUALIFIEDACTIVEFUTURE
reasons_for_event
optional string
The reasons for the event
appointment_datetime
optional datetime
The date when the appointment will occur
time_from
optional string
time_to
optional string
title
optional string
The title associated with the event
agent_name
optional string
The name of the leasing agent associated with the event

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