Events

Create event for an applicant

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

Request

This endpoint expects an object.
integration_id
string
applicant_id
optional string
The Propexo unique identifier for the applicant
event_type_id
optional string
The Propexo unique identifier for the event type
name
optional string
The name associated with the event type
employee_id
optional string
The Propexo unique identifier for the employee
unit_id
optional string
The Propexo unique identifier for the unit. Only some PMS events use this, including "Show" and "Appointment"
event_datetime
optional datetime
The date when the event will occur
reasons_for_event
optional string
The reasons for the event
notes
optional string
Notes associated with 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
event_name
optional enum
The name or type of event
agent_name
optional string
The name of the leasing agent associated with the event
event_type
optional "Note"

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