GUguesty
Owners Reservations

Update an owner reservation

Changed on

Use this request to alter an owner's reservation.

Note: This endpoint will be deprecated as part of the move to the Reservations Open API [Beta] (v3). See the Reservations V3 Booking Flow guide for what's available today.

put/owners-reservations/{id}

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/owners-reservations/{id}
  • Auth
    API key in header authorization

Path parameters

idstring required

Reservation ID

Request body

checkInstring required

Check in with format YYYY-MM-DD HH:mm:ss

checkOutstring required

Check out with format YYYY-MM-DD HH:mm:ss

notestring

Free text note about the reservation.

Example request

{
  "checkIn": "2020-03-19 15:00:00",
  "checkOut": "2020-03-20 10:00:00",
  "note": "Free text"
}

Response

Updated owner reservation

_idstring

Unique Guesty listing/unit type ID.

statusstring
sourcestring
accountIdstring

Unique Guesty listing/unit type ID.

listingIdstring

Unique Guesty listing/unit type ID.

checkInstring
checkOutstring
notestring
__vnumber
createdAtstring
checkInDateLocalizedstring
checkOutDateLocalizedstring
plannedDeparturestring
plannedArrivalstring
lastUpdatedAtstring
nightsCountnumber
idstring

Example response

{
  "_id": "563e0b6a08a2710e00057b82",
  "accountId": "563e0b6a08a2710e00057b82",
  "listingId": "563e0b6a08a2710e00057b82",
  "listing": {
    "_id": "59ac245d27cb310f0017afe3",
    "accountId": "59ac245d27cb310f0017afe3",
    "createdAt": "2017-09-03T15:48:45.070Z",
    "integrations": [
      {
        "_id": "5958c7e5884e961000817799",
        "airbnb2": {
          "ignored": {
            "reservations": [],
            "listings": []
          },
          "emailsFromSupport": []
        },
        "nickname": "naama",
        "id": "naama@user.guesty.com",
        "userId": "563e0b6a08a2710e00057b85",
        "accountId": "563e0b6a08a2710e00057b82"
      }
    ],
    "address": {
      "full": "Kaplan St 2, Ramat Gan, Israel",
      "lng": 34.8202173,
      "lat": 32.0695525
    },
    "publishedAddress": {
      "full": "Kaplan St 2, Ramat Gan, Israel",
      "lng": 34.8202173,
      "lat": 32.0695525
    },
    "cleaningStatus": {
      "updatedAt": "2019-08-24T14:15:22Z"
    },
    "picture": {
      "thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1659982852/staging6/5213a2d206112710005d96ff/gglflnes8vodgkmtm08c.jpg",
      "large": "https://res.cloudinary.com/guesty/image/upload/c_fit,w_756/v1659982852/staging6/5213a2d206112710005d96ff/gglflnes8vodgkmtm08c.jpg",
      "caption": "Living room",
      "height": 756,
      "original": "https://res.cloudinary.com/guesty/image/upload/v1659982852/staging6/5213a2d206112710005d96ff/gglflnes8vodgkmtm08c.jpg",
      "size": 39516,
      "width": 756
    },
    "pictures": [
      {
        "thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1659982852/staging6/5213a2d206112710005d96ff/gglflnes8vodgkmtm08c.jpg",
        "large": "https://res.cloudinary.com/guesty/image/upload/c_fit,w_756/v1659982852/staging6/5213a2d206112710005d96ff/gglflnes8vodgkmtm08c.jpg",
        "caption": "Living room",
        "height": 756,
        "original": "https://res.cloudinary.com/guesty/image/upload/v1659982852/staging6/5213a2d206112710005d96ff/gglflnes8vodgkmtm08c.jpg",
        "size": 39516,
        "width": 756
      }
    ],
    "terms": {
      "minNights": 1,
      "maxNights": 30,
      "cancellation": "STANDARD"
    },
    "prices": {
      "guestsIncludedInRegularFee": 6,
      "extraPersonFee": 55.5,
      "monthlyPriceFactor": 0.9,
      "weeklyPriceFactor": 0.9,
      "weekendBasePrice": 150,
      "securityDepositFee": 100,
      "cleaningFee": 50
    },
    "pms": {
      "cleaningStatus": {
        "updatedAt": "2019-08-24T14:15:22Z"
      }
    }
  },
  "owner": {
    "ownersPortalSettings": {
      "ownersPortalSettings": {
        "bookedNights": true,
        "revenue": true
      }
    },
    "listings": [
      "5e32fc021690ba0026f6f778",
      "5e32fc021690d15417543012",
      "5e32fc021690d15417543013"
    ],
    "_id": "563e0b6a08a2710e00057b82",
    "locale": "en-US",
    "firstName": "Elad",
    "lastName": "Kremer",
    "fullName": "Elad Kremer",
    "email": "example@guesty.com",
    "address": "test address",
    "phone": "15417543010",
    "picture": {
      "thumbnail": "https://cdn.filepicker.io/api/file/bBnKEk8TlmJAUHcLApRx",
      "large": "https://cdn.filepicker.io/api/file/bBnKEk8TlmJAUHcLApRx"
    },
    "notes": "this is a note",
    "createdAt": "2020-03-13T12:17:06.758Z"
  }
}

Changes

  • 3122b8618183Revision changes
    • breaking

      the /// response's property type changed from integer to string for status

    • info

      api operation id ownerReservationsUpdate was added

    • info

      endpoint deprecated

    • info

      added the optional property / to the response with the status

    • info

      the // response's property pattern ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$ was added for the status