Appointments

Update an appointment for a lead

Update an appointment for a lead

put/v1/events/appointments/leads/{event_id}

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/events/appointments/leads/{event_id}
  • Auth: HTTP bearer

Path parameters

event_idstring required

The Propexo unique identifier for the event

Request body

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

employee_idstring

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

notesstring

Notes associated with the event

unit_idstring

The Propexo unique identifier for the unit

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

titlestring

The title associated with the event

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

dataV1EventsAppointmentsLeadsEventIdPutOutputData required

Changes

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