API ReferenceEvents

Create event for a resident

Create a resident event for an integration.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
integration_idstringRequired
resident_idstringOptional
The Propexo unique identifier for the resident
event_typeenumOptionalDefaults to Note
The type of event
Allowed values:
notesstringOptional
Notes associated with the event
event_type_idstringOptional
The Propexo unique identifier for the event type
employee_idstringOptional

The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT

unit_idstringOptional
The Propexo unique identifier for the unit
event_datetimestringOptionalformat: "date-time"
The date when the event will occur
reasons_for_eventstringOptional
The reasons for the event
appointment_datetimestringOptionalformat: "date-time"
The date when the appointment will occur
time_fromstringOptional
time_tostringOptional
titlestringOptional
The title associated with the event
statusenumOptional
The raw status associated with the event
Allowed values:
event_namestringOptional
The name or type of event

Response

Successful response
job_idstring
The ID of the job created to handle this operation
dataobject

Errors