Create event for an applicant

POST

/v1/events/applicants

Create an applicant event for an integration.

This endpoint expects an object.

integration_idstringRequired

applicant_idstringOptional

The Propexo unique identifier for the applicant

event_type"Note"OptionalDefaults to Note

The type of event

notesstringOptional

Notes associated with the event

application_idstringOptional

The Propexo unique identifier for the application

event_type_idstringOptional

The Propexo unique identifier for the event type

employee_idstringOptional

The Propexo unique identifier for the employee

unit_idstringOptional

The Propexo unique identifier for the unit. Only some PMS events use this, including “Show” and “Appointment”

event_datetimedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date when the event will occur

reasons_for_eventstringOptional

The reasons for the event

appointment_datetimedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date when the appointment will occur

time_fromstringOptional

time_tostringOptional

titlestringOptional

The title associated with the event

event_nameenumOptional

The name or type of event

agent_namestringOptional

The name of the leasing agent associated with the event

Successful response

job_idstring

The ID of the job created to handle this operation

dataobject

1	curl -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	}'