Events

Create an appointment for an applicant

POST
Create an appointment for an applicant

Request

This endpoint expects an object.
integration_id
stringRequired
applicant_id
stringOptional
The Propexo unique identifier for the applicant
application_id
stringOptional
The Propexo unique identifier for the application
unit_id
stringOptional
The Propexo unique identifier for the unit
appointment_datetime
datetimeOptional
The date when the appointment will occur
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

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.
POST
1curl -X POST https://api.propexo.com/v1/events/appointments/applicants \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "integration_id": "integration_id"
6}'
200Successful
1{
2 "job_id": "clwh5uics000608me9v74du0a",
3 "data": {}
4}