Send the day's guest messages for a property

post/lodging/desk/messages/run

Send the day's guest messages for a property: pre-arrival for tomorrow's confirmed arrivals, welcome for today's check-ins, thanks for today's check-outs. Each guest gets each message once.

Before you call

Credential: Authorization: Bearer $KEY
Scope: bookings:write
Sdk: bookings.guestMessage.run
Cli: bookings guest message run

Request bodyapplication/json, required

propertyIdstring (uuid)required
datestring
Pattern: ^\d{4}-\d{2}-\d{2}$.

Responses

200application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/lodging/desk/messages/run' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "propertyId": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown