Reviews

Gets the review thread associated with a given reservation

The Guest Review thread becomes available within a few hours after the reservation has ended, depending on the processing time of the sales channel.

get/api/reviews/thread/{reservationId}

Request

  • Base URL: https://api.rentalsunited.com
  • URL: https://api.rentalsunited.com/api/reviews/thread/{reservationId}
  • Auth: one of:
    • API key in header X-RU-AccessKey and API key in header X-RU-SecretKey
    • HTTP basic

Path parameters

reservationIdinteger required

The ID of the reservation object the review thread is attached to

Response

OK

IDinteger required

The ID of the thread

ParentType'RUReservation' | 'PMSReservation' | 'Contact' required

The type of object the thread is attached to

ParentIDinteger required

The ID of the object the thread is attached to

CommunicationChannelstring required

The communication channel messages in thread will be sent over. For dedicated channels this is the channel name (e.g. "Airbnb", "BookingCom", "Email"); for generic PULL sales channels it is the sales channel name.

RecipientNamestring

The recipient's first name followed by last name (if provided)

RecipientRole'Unknown' | 'SalesChannel' | 'Guest' required

The role of the recipient in the context of the reservation

Previewstring required

The first 100 characters of the thread subject or the first 100 characters of the latest message (if subject is not applicable)

LastMessageDatestring date-time

The date and time of the latest message in the thread in UTC

HasAttachmentboolean required

Indicates whether the thread has any messages that contain attachments

NumberOfUnreadMessagesinteger required

The number of unread messages in the thread

Changes

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