Rivier/ Reference/ bookings

Schedule one message for one stay at a date and time

post/lodging/scheduled-messages

Schedule one message for one stay at a date and time; it can be changed or cancelled until it is sent.

Before you call

Credential
Authorization: Bearer $KEY
Scope
bookings:write
Sdk
bookings.scheduledMessage.create
Cli
bookings scheduled message create

Request bodyapplication/json, required

  • bookingIdstring (uuid)required
  • subjectstringrequired
    At most 200 characters.
  • bodystringrequired
    At most 6000 characters.
  • sendAtstring (date-time)required

Responses

  • 201application/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

    This page as Markdown