Multi Island & v1.2 FAQ

Multi Island Third Announcement to API Partners - Action Required

Please feel free to reach out to us via Stack Overflow tagging your questions with "cloudbeds", alternatively you can contact us via [email protected].

FAQs

Is this unlocking any customer-facing features?

Future new API Endpoints will be included in the latest version only v1.2, whereas the current version will be kept and maintained with current API Endpoints.

API Integers that have converted into strings from v1.1 to v1.2 - REQUEST

Endpoint	Parameter
/getAdjustment	propertyID
/getAdjustments	propertyID
/deleteAdjustment	propertyID
/postAdjustment	propertyID itemID
/getCurrencySettings	propertyID
/getCustomFields	propertyID customFieldID
/postCustomField	propertyID
/getDashboard	propertyID
/getEmailTemplates	propertyID
/postEmailTemplate	propertyID
/getEmailSchedule	propertyID
/postEmailSchedule	propertyID emailTemplateID
/getGuest	propertyID guestID
/getGuestList	propertyIDs
/getGuestsModified	propertyIDs
/getGuestsByStatus	propertyID
/getGuestsByFilter	propertyIDs
/postGuestNote	propertyID guestID userID
/getGuestNotes	propertyID guestID
/putGuestNote	propertyID guestID
/deleteGuestNote	propertyID guestID
/putGuest	propertyID guestID
/postGuestDocument	propertyID guestID
/postGuest	propertyID
/postGuestsToRoom	propertyID
/postGuestPhoto	guestID
/getHouseAccountList	propertyID
/getHouseAccountDetails	propertyID houseAccountID
/postNewHouseAccount	propertyID
/putHouseAccountStatus	propertyID houseAccountID
/getHousekeepingStatus	propertyID
/postHousekeepingStatus	propertyID
/postHousekeeper	propertyID
/putHousekeeper	propertyID housekeeperID
/postHousekeepingAssignment	propertyID housekeeperID
/getAppState	propertyID
/postAppState	propertyID
/postGovernmentReceipt	propertyID houseAccountID
/getAppSettings	propertyID
/postAppSettings	propertyID
/postAppError	propertyID
/invoice	propertyID invoiceID
/getItem	propertyID ItemID
/putItemToInventory	propertyID ItemID
/getItems	propertyID itemCategoryID
/getItemCategories	propertyID
/postItemCategory	propertyID
/postItemsToInventory	item.propertyID item.categoryID
/postItemToReservation	propertyID itemID
/postItem	propertyID houseAccountID itemID
/postCustomItem	propertyID houseAccountID guestID
/appendCustomItem	propertyID guestID
/deleteItemFromReservation	soldProductID
/postVoidItem	propertyID soldProductID
/getPackages	propertyID
/getPackageNames	propertyID
/postPaymentCreditCard	cardID
/getPayments	propertyID houseAccountID guestID
/getTransactions	propertyID guestID houseAccountID
/postPayment	propertyID houseAccountID
/postCustomPaymentMethod	propertyID
/getPaymentMethods	propertyID
/postVoidPayment	propertyID houseAccountID paymentID
/getReservation	propertyID
/postReservation	propertyID sourceID rooms.roomTypeID rooms.roomRateID adults.roomTypeID children.roomTypeID
/getReservations	propertyID
/getReservationsWithRateDetails	propertyID
/getReservationAssignments	propertyID
/getReservationInvoiceInformation	propertyID
/postReservationNote	propertyID userID
/getReservationNotes	propertyID
/putReservationNote	propertyID reservationNoteID
/deleteReservationNote	propertyID
/putReservationDetails	propertyID
/postReservationDocument	propertyID
/putReservation	propertyID rooms.roomTypeID
/getRoomsFeesAndTaxes	propertyID
/postRoomAssign	propertyID roomTypeID
/postRoomCheckIn	propertyID
/postRoomCheckOut	propertyID
/getReservationRoomDetails	propertyID
/postRoomBlock	propertyID rooms.roomTypeID
/getRoomBlocks	propertyID roomTypeID
/putRoomBlock	propertyID rooms.roomTypeID
/deleteRoomBlock	propertyID
/getTaxesAndFees	propertyID
/postWebhook	propertyID
/getWebhooks	propertyID
/getHotelDetails	propertyID
/postFile	propertyID
/getFiles	propertyID
/getRoomsUnassigned	propertyIDs
/userinfo	property_id
/getAllotmentBlocks	propertyID
/updateAllotmentBlock	allotmentIntervals.roomTypeId
/deleteAppPropertySettings	propertyID
/getAppPropertySettings	propertyID
/postAppPropertySetting	propertyID
/putAppPropertySettings	propertyID
/patchGroup	propertyID
/putGroup	propertyID
/getRate	roomTypeID
/getRateJobs	jobReferenceID
/patchRate	rates.rateID
/putRate	rates.rateID

API Integers that have converted into strings from v1.1 to v1.2 - RESPONSE

Endpoint	Response Value
/getUsers	data.userID data.propertyId
/postOrgGuest	guestID
/putOrgGuest	guestID
/getOrgGuestList	data.guestID data.guestNotes.ID data.newGuestID
/getAdjustment	data.propertyID
/getCustomFields	data.propertyID
/postCustomField	data.fieldID
/postEmailTemplate	emailTemplateID
/postEmailSchedule	emailScheduleID
/getGuest	data.newGuestID
/getGuestList	data.guestID data.guestNotes.ID data.newGuestID
/getGuestsModified	data.guestID data.roomTypeID data.newGuestID
/getGuestsByStatus	data.guestID data.roomTypeID data.newGuestID
/getGuestsByFilter	data.guestID data.newGuestID
/postGuest	guestID
/postNewHouseAccount	data.houseAccountID
/getHousekeepingStatus	data.roomTypeID data.housekeeperID
/postHousekeeper	housekeeperID
/getHousekeepers	data.propertyID data.housekeeperID
/getItem	data.itemID data.categoryID
/getItems	data.itemID data.categoryID
/getItemCategories	data.categoryID
/postItemCategory	categoryID
/postItemsToInventory	data.itemID
/postItemToReservation	data.soldProductID
/postItem	data.soldProductID
/postCustomItem	data.soldProductID
/appendCustomItem	data.soldProductID
/getPayments	data.paymentID data.propertyID data.userID data.guestID data.houseAccountID
/getTransactions	data.propertyID data.houseAccountID data.guestID data.roomTypeID
/postPayment	paymentID
/getPaymentMethods	data.propertyID
/getReservation	data.guestList.guestID data.assigned.roomTypeID data.unassigned.roomTypeID data.cardsOnFile.cardID
/postReservation	unassigned.roomTypeID
/getReservations	data.guestID
/getReservationsWithRateDetails	data.reservations.rooms.roomTypeID data.reservations.rooms.rateID
/getReservationAssignments	data.assigned.roomTypeID
/getReservationInvoiceInformation	data.reservationRooms.roomTypeID data.reservationAdditionalProducts.productID data.reservationAdditionalProducts.soldProductID data.reservationAddOnProducts.soldProductID
/postReservationNote	reservationNoteID
/getReservationNotes	data.reservationNoteID
/getSources	data.propertyID
/getReservationRoomDetails	data.guestID data.roomTypeID data.guests.guestID
/postRoomBlock	propertyID rooms.roomTypeID
/getRoomBlocks	data.rooms.roomTypeID
/putRoomBlock	propertyID rooms.roomTypeID
/getHotels	data.propertyID
/getHotelsNear	data.propertyID
/getHotelDetails	data.propertyID
/postFile	data.fileID
/getFiles	data.fileID
/getRoomTypes	data.roomTypeID data.propertyID
/getAvailableRoomTypes	data.propertyID data.propertyRooms.roomTypeID data.propertyRooms.roomRateID
/getRooms	data.propertyID data.rooms.roomTypeID
/getRoomsUnassigned	data.propertyID data.rooms.roomTypeID
/userinfo	user_id
/createAllotmentBlock	data.propertyID data.ratePlanId data.groupId data.allotmentIntervals.roomTypeId
/getAllotmentBlocks	data.propertyID data.ratePlanId data.groupId data.allotmentIntervals.roomTypeId
/updateAllotmentBlock	data.propertyID data.ratePlanId data.groupId data.allotmentIntervals.roomTypeId
/postAppGlobalSetting	data.id
/putAppGlobalSetting	data.id
/getAppPropertySettings	data.id
/postAppPropertySetting	data.id
/putAppPropertySettings	data.id
/patchGroup	data.id
/putGroup	data.id
/postCreditCard	data.cardID
/getRate	data.rateID
/getRateJobs	data.jobReferenceID data.updates.rateID
/getRatePlans	data.rateID data.roomTypeID data.propertyID data.ratePlanID data.addOns.addOnID data.addOns.itemID
/patchRate	jobReferenceID
/putRate	jobReferenceID