Appointments

Create an appointment for an applicant

Create an appointment for an applicant

post/v1/events/appointments/applicants

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/events/appointments/applicants
  • Auth: HTTP bearer

Request body

integration_idstring required
applicant_idstring

The Propexo unique identifier for the applicant

application_idstring

The Propexo unique identifier for the application

unit_idstring

The Propexo unique identifier for the unit

appointment_timestring

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_minutesinteger

The duration of the appointment, in minutes

appointment_type'LEASING_APPOINTMENT' | 'SELF_GUIDED_TOUR' | 'TOUR' | 'VIRTUAL_TOUR'

The type of appointment. This is specific to Entrata and correlates to the types of calendar appointments available

notesstring

Notes associated with the event

titlestring

The title associated with the event

employee_idstring

The Propexo unique identifier for the employee

status'COMPLETED' | 'OPEN' | 'REVIEW' | 'DENIED'

The raw status associated with the event

priority'HIGH' | 'MEDIUM' | 'LOW'

The priority of the appointment

Response

Successful response

job_idstring required

The ID of the job created to handle this operation

dataV1EventsAppointmentsApplicantsPostOutputData required

Changes

No recorded changes to this operation across all 1 revision of this API.