Login
DocumentationKnowledge BaseAPI ReferenceUse Cases
  • Introduction
    • Overview
  • API Reference
Login
LogoLogo
API ReferenceAppointments

POST
/v1/events/appointments/residents
POST
/v1/events/appointments/residents
1curl -X POST https://api.propexo.com/v1/events/appointments/residents \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "integration_id": "string"
6}'
Try it
1{
2  "job_id": "string",
3  "data": {}
4}
Was this page helpful?
Previous

Update an appointment for an applicant

Next
Built with
Create an appointment for a resident
Create an appointment for a resident

Authentication

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

Request

This endpoint expects an object.
integration_idstringRequired
resident_idstringOptional
The Propexo unique identifier for the resident
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. The time is in the local time of the property/location. In Rent Manager, the default timezone is an optional setting that the PMC can set and will be stored on the Propexo Timezone model. You may need to read in this setting and convert to the local timezone for the appointment time to be correct.
employee_idstringOptional
The Propexo unique identifier for the employee
statusenumOptional
The raw status associated with the event
Allowed values:
notesstringOptional
Notes associated with the event
appointment_duration_minutesintegerOptional
The duration of the appointment, in minutes
titlestringOptional<=50 characters
The title associated with the event

Response

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

Errors

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

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. In Rent Manager, the default timezone is an optional setting that the PMC can set and will be stored on the Propexo Timezone model. You may need to read in this setting and convert to the local timezone for the appointment time to be correct.