Appointments

Create an appointment for a lead

POST
Create an appointment for a lead

Request

This endpoint expects an object.
integration_id
stringRequired
lead_id
stringOptional
The Propexo unique identifier for the lead
unit_id
stringOptional
The Propexo unique identifier for the unit
appointment_date
unionOptional
The date when the appointment will occur
appointment_time
stringOptional
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. The time is in the local time of the property/location.
appointment_duration_minutes
integerOptional
The duration of the appointment, in minutes
appointment_type
enumOptional
The type of appointment. This is specific to Entrata and correlates to the types of calendar appointments available
Allowed values: LEASING_APPOINTMENTSELF_GUIDED_TOURTOURVIRTUAL_TOUR
notes
stringOptional
Notes associated with the event
title
stringOptional
The title associated with the event
employee_id
stringOptional
The Propexo unique identifier for the employee
priority
enumOptional
The priority of the appointment
Allowed values: HIGHMEDIUMLOW
lead_source_id
stringOptional
The Propexo unique identifier for the lead source

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.