PMS Generic APIsAppointments

Create an appointment for an applicant

Create an appointment for an applicant

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
integration_idstringRequired
applicant_idstringOptional
The Propexo unique identifier for the applicant
application_idstringOptional
The Propexo unique identifier for the application
unit_idstringOptional
The Propexo unique identifier for the unit
appointment_datestringOptional
The date when the appointment will occur
appointment_timestringOptionalformat: "(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)"
The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones
appointment_duration_minutesintegerOptional
The duration of the appointment, in minutes
appointment_typeenumOptional
The type of appointment. This is specific to Entrata and correlates to the types of calendar appointments available
Allowed values:
notesstringOptional<=256 characters
Notes associated with the event
titlestringOptional<=50 characters
The title associated with the event
employee_idstringOptional
The Propexo unique identifier for the employee
statusenumOptional
The raw status associated with the event
Allowed values:
priorityenumOptional
The priority of the appointment
Allowed values:

Response

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

Errors