v1

latestOpenAPI 3.1.02026-07-24700152.8 KB

Update reservation

When reservation moves from one property to another, the original reservation needs to be deleted and a new one created to properly support internal processes.

patch/reservation/{id}

Path parameters

idinteger required

Reservation ID from Breezeway system

Request body

reference_reservation_idstring

Reservation ID from external system

company_idinteger

Company ID from Breezeway system (required only if using cross-company access)

checkin_datestring date

ISO 8601 date format

checkin_timestring

ISO 8601 time format (HH:MM:SS)

checkout_datestring date

ISO 8601 date format

checkout_timestring

ISO 8601 time format (HH:MM:SS)

notestring

number_peopleinteger

Number of guests in reservation

type_stay'guest' | 'owner'

type_reservation'booking' | 'hold' | 'lockoff'

access_codestring

Guest access code

tagsinteger[]

List of reservation tags; must match tags available via "List available reservation tags"

Response

200

checkin_datestring

{"stackTrail":"paths:/reservation/{id}:patch:responses:200:content:application/json:schema:properties:checkin_early","oasType":"schema","type":"unknown"}

checkin_timestring

checkout_datestring

{"stackTrail":"paths:/reservation/{id}:patch:responses:200:content:application/json:schema:properties:checkout_late","oasType":"schema","type":"unknown"}

checkout_timestring

idinteger

{"stackTrail":"paths:/reservation/{id}:patch:responses:200:content:application/json:schema:properties:note","oasType":"schema","type":"unknown"}

property_idinteger

reference_external_property_idstring

reference_property_idstring

reference_reservation_idstring

statusstring

{"stackTrail":"paths:/reservation/{id}:patch:responses:200:content:application/json:schema:properties:type_guest","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/reservation/{id}:patch:responses:200:content:application/json:schema:properties:type_stay","oasType":"schema","type":"unknown"}

Example response

{
  "checkin_date": "2022-08-16",
  "checkin_time": "15:00:00",
  "checkout_date": "2022-08-18",
  "checkout_time": "10:00:00",
  "guests": [
    {
      "emails": [
        "john@doe.come"
      ],
      "first_name": "John",
      "last_name": "Does",
      "phone_numbers": [
        {
          "dial_code": "1",
          "phone_number": "9159969739",
          "primary": true
        }
      ]
    }
  ],
  "id": 15486276,
  "property_id": 8542,
  "reference_external_property_id": "peyto_home",
  "reference_property_id": "peyto_home",
  "reference_reservation_id": "8546225",
  "status": "active",
  "tags": [
    {
      "id": 80,
      "name": "VIP"
    }
  ],
  "type_reservation": {
    "code": "hold",
    "name": "Hold"
  }
}