Events

Create event for an applicant

POST
Create an applicant event for an integration.

Request

This endpoint expects an object.
integration_id
stringRequired
applicant_id
stringOptional
The Propexo unique identifier for the applicant
event_type
"Note"Optional
The type of event
notes
stringOptional
Notes associated with the event
application_id
stringOptional
The Propexo unique identifier for the application
event_type_id
stringOptional
The Propexo unique identifier for the event type
employee_id
stringOptional
The Propexo unique identifier for the employee
unit_id
stringOptional
The Propexo unique identifier for the unit. Only some PMS events use this, including "Show" and "Appointment"
event_datetime
datetimeOptional
The date when the event will occur
reasons_for_event
stringOptional
The reasons for the event
appointment_datetime
datetimeOptional
The date when the appointment will occur
time_from
stringOptional
time_to
stringOptional
title
stringOptional
The title associated with the event
event_name
enumOptional
The name or type of event
agent_name
stringOptional
The name of the leasing agent associated with the event

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.
POST
1curl -X POST https://api.propexo.com/v1/events/applicants \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "integration_id": "integration_id"
6}'
200Successful
1{
2 "job_id": "clwh5uics000608me9v74du0a",
3 "data": {}
4}