Changelog
Back to All

January 2025 - API v1.1 deprecated by March 31st, 2025

28 days ago by Gabriela Rubio

Dear Cloudbeds Customer and Partner, we sent you the following communication with an Action Required as Cloudbeds API v1.1 will be deprecated by March 31st, 2025

We're contacting you to inform you that Cloudbeds API version 1.1 will be deprecated on March 31st, 2025. For that reason, you must transition to Cloudbeds API v1.2 by that date. If you are currently using Cloudbeds API v1.2, no further action is required.
Please visit our ChangeLog and Partner Portal for other regular updates.

FAQs

What changes?

  • The main change to v1.2 is the new URL https://api.cloudbeds.com/api/v1.2/{method}
  • Potential switch from Integers to string depending on the language used.
  • X-property-ID parameter in the request headers is not required but is strongly suggested.

Any additional potential considerations?

The change is meant to be as easy as we could make it for all our partners.

  • It's changing a number of fields that were integers to be strings: identifiers like the propertyID, organizationID, itemID, guestID ... This is to ensure compatibility with languages like JScript for larger integers.
  • Depending on the language you're using and the models you've built for the API this will require some changes but hopefully they are small.
  • You might have more work to do where you're storing those values, for example if you have them in a SQL database you may need to migrate the data.
  • The API's are interchangeable in that you can migrate one API call at a time if this is your preference, it's possible to call a mix of v1.1 and v1.2 API's as you migrate, the identifiers remain the same except for the data type. The paths for the API's also remain the same, the only change in the request URL is in the version portion.
  • For webhook payloads, the version of those remains the same but the payload includes both the old integer and new string values, the new values have the "_str" suffix:
    • e.g.: propertyId_str
    • The string version should be used in the payload during migration.
  • Multi-island & v1.2 FAQ includes a list of each API and the integer values that have changed to strings in v1.2 in both requests and responses.

Related articles

Multi Island API Announcement to Partners (Updated - January 2024)

https://developers.cloudbeds.com/reference/get_gettransactions