Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Reservations Open Api [Beta]

Create a mid-stay

Relocate guests to a different listing during their stay

post/reservations-v3/mid-stay

Request body

reservationIdstring required

Reservation ID

checkInDateLocalizedstring required
unitTypeIdstring required
unitIdstring required
ratePlanIdstring

Example request

{
  "reservationId": "6213b03e7f0ba50032296f4a",
  "checkInDateLocalized": "2024-01-25",
  "unitTypeId": "65aff36cbf774b59c718a0c7",
  "unitId": "65aff3853c12c9228bca87f1",
  "ratePlanId": "65aff3853c12c9228bca87f1"
}

Response

Mid-Stay Created

_idobject required
integrationIdobject required
bookerIdstring required
platformstring required
quoteIdobject required
accountIdobject required
sourcestring required
confirmedAtstring date-time required
moneyIdstring required
alteredAtstring date-time
conversationIdstring required
creationFlow'OPEN_API' | 'INTERNAL' | 'RESERVATIONS_UPLOAD' | 'MAILER' required
createdAtstring date-time required
status'confirmed' | 'reserved' | 'awaiting_payment' | 'inquiry' | 'canceled' | 'closed' | 'declined' | 'expired' required
confirmationCodestring required

Example response

{
  "stay": [
    {
      "checkInDateLocalized": "2021-12-20",
      "checkOutDateLocalized": "2021-12-22",
      "guestsCount": 3,
      "numberOfGuests": {
        "numberOfAdults": 3,
        "numberOfChildren": 0,
        "numberOfInfants": 0
      },
      "unitTypeId": "5e384c9fc2700d002670b61b",
      "unitId": "5e384c9fc2700d002670b61b",
      "ratePlanId": "5e384c9fc2700d002670b61b"
    }
  ],
  "bookerId": "df7hf01cnduhdb2125854dj8",
  "platform": "direct",
  "source": "fb-campaign-01",
  "moneyId": "df7hf01cnduhdb2125854dj8",
  "conversationId": "df7hf01cnduhdb2125854dj8"
}