Messages

Lists all messages associated with a given thread parent object

get/api/messaging/messages

Request

  • Base URL: https://api.rentalsunited.com
  • URL: https://api.rentalsunited.com/api/messaging/messages
  • Auth: one of:
    • API key in header X-RU-AccessKey and API key in header X-RU-SecretKey
    • HTTP basic

Query parameters

parentType'RUReservation' | 'PMSReservation' | 'Contact' required

The type of the parent object the threads containing the messages are attached to

parentIdstring required

The ID of the parent object the threads containing the messages are attached to

newerThanstring date-time

The date and time limiting the number of returned messages in UTC, only messages newer than this date will be returned

Response

OK

IDinteger required

The ID of the message

ThreadIDinteger required

The ID of the thread containing the message

Bodystring required

The body of the message in HTML format

CreateDatestring date-time required

The date and time of when the message was created in UTC

IsIncomingboolean required

Whether the message is incoming as opposed to being sent by the user

ReadDatestring date-time

The date and time of when the message was read by the user in UTC. Can be empty

SenderType'Undefined' | 'Host' | 'Guest' | 'Cohost'

Represents the type of the sender in the context of the reservation

SenderNamestring required

The full name of the sender

SenderInitialsstring required

The initials of the sender

Changes

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