API ReferenceEvents

Create event for a lead

Create a lead event for an integration.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
integration_idstringRequired
lead_idstringOptional

The Propexo unique identifier for the lead

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

notesstringOptional

Notes associated with 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

statusenumOptional

The status associated with the event

Allowed values:
agent_namestringOptional

The name of the leasing agent associated with the event

Response

Successful response

job_idstring

The ID of the job created to handle this operation

dataobject

Errors