v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Reservations Open Api [Beta]

Update Reservation Guests Breakdown

Update the reservation guest count, including the guest breakdown object (adults, children, infants, pets, etc.). Financial recalculation is automatically applied

put/reservations-v3/{reservationId}/guests

Path parameters

reservationIdstring required

Example:5f92cbf10cf217478ba93561

The Guesty reservation ID

Query parameters

mergeAccommodationFarePriceComponentsboolean

If set to true, Markups, ExtraPersonFee, and Discounts are hidden from both the nightly rates and invoice items—they are included within the Accommodation Fee (AF). If set to false, these components are itemized separately in the response.

Request body

ignoreCalendarboolean

The system will check calendar availability and decline if unavailable unless this flag is set to true

ignoreTermsboolean

The system will ensure the reservation accords with the terms (min, max nights, any other terms) of the property and will decline if it does not. To override, set this flag to true

ignoreBlocksboolean

Set this flag to true to ignore existing flexible blocks

guestsCountnumber required

The number of guests is to be included in the reservation

Example request

{
  "ignoreCalendar": true,
  "ignoreTerms": true,
  "ignoreBlocks": true,
  "guestsCount": 3,
  "numberOfGuests": {
    "numberOfChildren": 1,
    "numberOfInfants": 0,
    "numberOfPets": 1,
    "numberOfAdults": 2
  }
}

Response

Success

reservationIdstring required

guestsCountnumber required

Example response

{
  "money": {
    "invoiceItems": [
      {
        "title": "Cleaning fee",
        "amount": 20,
        "currency": "USD",
        "type": "CLEANING_FEE",
        "isLocked": true,
        "normalType": "CF"
      }
    ]
  },
  "numberOfGuests": {
    "numberOfChildren": 1,
    "numberOfInfants": 1,
    "numberOfPets": 1,
    "numberOfAdults": 1
  }
}