Events

Create event for a resident

POST
Create a resident event for an integration.

Request

This endpoint expects an object.
integration_id
stringRequired
resident_id
stringOptional
The Propexo unique identifier for the resident
event_type
string literalOptional
The type of event
Allowed value: Note
notes
stringOptional
Notes associated with the event
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
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
stringOptional
The name or type of 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.