Rivier/ Reference/ bookings

Change a property's details, times or tax profile

patch/lodging/properties/{id}

Before you call

Credential
Authorization: Bearer $KEY
Scope
bookings:admin
Mcp
rivier_lodging_property_update
Sdk
bookings.property.update
Cli
bookings property update

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • namestring
    At most 120 characters.
  • currencystring
    Pattern: ^[a-z]{3}$.
  • addressobject
    Default: {}.
  • checkInTimestring
    Default: 15:00. Pattern: ^([01]\d|2[0-3]):[0-5]\d$.
  • checkOutTimestring
    Default: 11:00. Pattern: ^([01]\d|2[0-3]):[0-5]\d$.
  • languageslist of string
    Default: [].
  • legalEntityobject
    Default: {}.
  • registrationNostring or null
  • taxProfileobject
    Default: {}.
    • accommodationPercentnumber
      Default: 0. At least 0. At most 100.
    • ancillaryPercentnumber
      Default: 0. At least 0. At most 100.
    • inclusiveboolean
      Default: true.
    • sourceobject
      • urlstring (uri)required
        At most 500 characters.
      • verifiedOnstringrequired
        Pattern: ^\d{4}-\d{2}-\d{2}$.
  • slugstring
    At most 60 characters. Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$.
  • kindstring
    One of: hotel, bed_and_breakfast, guesthouse, hostel, apartment_hotel, villa, campsite, rental, resort. Default: hotel.
  • starRatingnumber or null
  • geoobject or null
  • geoPrecisionstring
    One of: exact, approximate. Default: exact.
  • entranceobject or null
  • contactobject
    Default: {}.
    • emailstring (email)
      At most 254 characters.
    • phonestring
      Pattern: ^+?[0-9 ()-]{6,20}$.
    • websitestring (uri)
      At most 300 characters.
    • reservationsEmailstring (email)
      At most 254 characters.
    • emergencyPhonestring
      Pattern: ^+?[0-9 ()-]{6,20}$.
  • registrationslist of object
    Default: [].
    • kindstringrequired
      At most 60 characters.
    • numberstringrequired
      At most 80 characters.
    • authoritystring
      At most 120 characters.
    • validUntilstring
      Pattern: ^\d{4}-\d{2}-\d{2}$.
  • policiesobject
    Default: {}.
    • childrenobject
      Default: {}.
      • allowedboolean
        Default: true.
      • freeUnderAgeinteger or null
        Default: null.
      • extraBedFeeMinorinteger or null
        Default: null.
    • petsobject
      Default: {}.
      • allowedstring
        One of: no, on_request, yes. Default: no.
      • feeMinorinteger or null
        Default: null.
      • feePerstring or null
        Default: null.
      • maxPetsinteger or null
        Default: null.
    • smokingobject
      Default: {}.
      • policystring
        One of: none, designated_areas, allowed. Default: none.
    • checkInobject
      Default: {}.
      • methodstring
        One of: front_desk, self_code, key_box, host_meets, other. Default: front_desk.
    • paymentobject
      Default: {}.
      • methodslist of string
        Default: [].
    • houseRulesobject
      Default: {}.
      • quietHoursobject or null
        Default: null.
      • partiesAllowedboolean
        Default: false.
      • minCheckInAgeinteger or null
        Default: null.
      • lateArrivalUntilstring or null
        Default: null.
      • ruleslist of string
        Default: [].
    • cancellationPolicyIdstring (uuid) or null
      Default: null.
  • 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