Create Resident Appointment: Rent Manager

POSThttps://api.propexo.com/v1/events/appointments/residents/rentmanager/

Create an appointment for a resident in Rent Manager. Rent Manager allows property managers to set both global and property specific timezone settings. These configurations can be pulled in via our GET /timezones API endpoint which should be utilized to determine the timezone for which your appointment is set. If no timezone settings are found, Rent Manager suggests by default you send your appointment in Eastern Time (UTC-5:00 or UTC-4:00 depending on daylight savings).

Method
POST /Appointments
POST /Appointments/{appointmentId}/AppointmentUser

Notice

This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.

Authentication

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

Request

This endpoint expects an object.

integration_idstringrequired

The Propexo unique identifier for the integration

resident_idstringrequired

The Propexo unique identifier for the resident

employee_idstring

The Propexo unique identifier for the employee

appointment_datestringrequired
The date when the appointment will occur
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
appointment_timestringrequired

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.

Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)

appointment_duration_minutesintegerrequired

The duration of the appointment, in minutes

Possible values: > 0

titlestringrequired

The title associated with the event

Possible values: <= 50 characters

notesstring

Notes associated with the event

Response

Successful response

meta objectrequired
job_idstringrequired
result objectrequired

integration_idstringrequired

The Propexo unique identifier for the integration

resident_idstringrequired

The Propexo unique identifier for the resident

employee_idstring | nullnullablerequired

The Propexo unique identifier for the employee

appointment_datestring | nullnullablerequired

Show 2 variants

• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$

appointment_timestringrequired

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.

Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)

appointment_duration_minutesintegerrequired

The duration of the appointment, in minutes

Possible values: > 0

titlestringrequired

The title associated with the event

Possible values: <= 50 characters

notesstring | nullnullablerequired

Notes associated with the event

Errors

• 400Bad Request

  error objectrequired
  codestringrequired
  Example: invalid_request
  messagestringrequired
  Example: invalid request
  details object
  property name*any
  Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}

POST /v1/events/appointments/residents/rentmanager/

curl -X POST https://api.propexo.com/v1/events/appointments/residents/rentmanager/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "string",
  "resident_id": "string",
  "appointment_date": "2024-07-29T15:51:28.071Z",
  "appointment_time": "string",
  "appointment_duration_minutes": 0,
  "title": "string"
}'

200 Successful response

{
  "meta": {
    "job_id": "string"
  },
  "result": {
    "integration_id": "string",
    "resident_id": "string",
    "employee_id": "string",
    "appointment_date": "2024-07-29T15:51:28.071Z",
    "appointment_time": "string",
    "appointment_duration_minutes": 0,
    "title": "string",
    "notes": "string"
  }
}