Rivier/ Reference/ bookings

Hold the nights for the visitor; limited per visitor

post/public/lodging/holds

Before you call

Credential
Authorization: Bearer $KEY
Scope
bookings:read
Graphql
Mutation.holdPublicStay
Sdk
bookings.publicStay.hold
Cli
bookings public stay hold
Publishable
yes

Request bodyapplication/json, required

  • propertyIdstring (uuid)required
  • roomTypeIdstring (uuid)required
  • ratePlanIdstring (uuid)required
  • arrivalstringrequired
    Pattern: ^\d{4}-\d{2}-\d{2}$.
  • departurestringrequired
    Pattern: ^\d{4}-\d{2}-\d{2}$.
  • adultsinteger
    Default: 2. At least 1. At most 20.
  • childreninteger
    Default: 0. At least 0. At most 20.
  • infantsinteger
    Default: 0. At least 0. At most 10.
  • promoCodestring
    At most 24 characters.
  • extraslist of object
    Default: [].
    • extraIdstring (uuid)required
    • quantityinteger
      Default: 1. At least 1. At most 50.
  • quotestring
    At most 4000 characters.
  • idempotencyKeystringrequired
    At most 120 characters.

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