Rivier/ Reference/ bookings

Bookings unit update

patch/lodging/units/{id}

Rename a room, move it to a floor or area, change its notes and what it changes about its room type, or archive it.

Before you call

Credential
Authorization: Bearer $KEY
Scope
bookings:admin
Mcp
rivier_lodging_unit_update
Sdk
bookings.unit.update
Cli
bookings unit update

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • namestring
    At most 60 characters.
  • floorstring or null
  • areaIdstring (uuid) or null
  • notesstring
    Default: . At most 2000 characters.
  • overridesobject
    Default: {}.
    • sizeM2integer
      At least 1. At most 5000.
    • bedroomsinteger
      At least 0. At most 30.
    • bathroomsnumber
      At least 0. At most 30.
    • smokingstring
      One of: non_smoking, smoking, either.
    • viewslist of string
    • sleepinglist of object
      • namestringrequired
        At most 60 characters.
      • kindstring
        One of: bedroom, living_room, studio, other. Default: bedroom.
      • bedslist of objectrequired
        • typestringrequired
          One of: single, double, queen, king, twin, sofa_bed, bunk, futon, crib, extra_bed.
        • countintegerrequired
          At least 1. At most 10.
  • contentobject
    Default: {}.
  • statusstring
    One of: active, archived.

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

    This page as Markdown