Threads

Creates a new message in the specified thread on behalf of a co-host account

Before you use this method, you need to grant Rentals United access to a co-host account in Rentals United. You need to do this in the Rentals United > Guest Planner > <a href="https://new.rentalsunited.com/My/GuestPlanner/ControlPanel">Control Panel</a>.

Read the detailed instructions <a href="https://docs.rentalsunited.com/hc/en-gb/articles/33814557100573">here</a> and make sure to follow all prerequisites.

<b>Error explanations:</b>

  • “The Airbnb co-host credentials are invalid. Please check your co-host account connections or contact support.”

Error message when the access is not granted. Go to <a href="https://new.rentalsunited.com/My/GuestPlanner/ControlPanel">Control Panel</a> and grant us access to the co-host account. See <a href="https://docs.rentalsunited.com/hc/en-gb/articles/33814557100573">here</a>.

  • “The Airbnb account does not have the required permissions to perform this action. Please check co-host permissions in Airbnb or contact support.”

Error when the co-host does not have permission for an Airbnb listing. Check <a href="https://www.airbnb.com/help/article/1244">this Airbnb article</a>.

  • “The provided co-host account with ID {CohostAccountID} was not found. Please check your co-host account connections or contact support.”

Error when a co-host with the specified CohostAccountID is not found. Make sure the CohostAccountID you provided in the message matches the CohostAccountID added in <a href="https://new.rentalsunited.com/My/GuestPlanner/ControlPanel">Control Panel</a>.

post/api/messaging/threads/{id}/messages/as-cohost/{cohostAccountId}

Request

  • Base URL: https://api.rentalsunited.com
  • URL: https://api.rentalsunited.com/api/messaging/threads/{id}/messages/as-cohost/{cohostAccountId}
  • Auth: one of:
    • API key in header X-RU-AccessKey and API key in header X-RU-SecretKey
    • HTTP basic

Path parameters

idinteger required

The ID of the thread

cohostAccountIdstring required

The Airbnb co-host account ID

Request body

Bodystring required

The body of the message in HTML format

Response

Created

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.