Deprecation and sunsetting

Page last updated on September 15, 2021

Deprecation is all about communicating changes to our API solutions. Therefore, it is not just about discontuing solutions, but it is about bringing you value by offering alternative or more efficient solutions to benefit your business.

Overview of content

This page aims to inform you how understands and communicates deprecation (and sunsetting). More precisely, it covers:

Deprecation and sunsetting dates

You can see an overview of the solutions with their deprecation and sunsetting dates in the following table. To learn more and see a detailed overview of each deprecation, click the solution.

→ To learn what deprecation and sunsetting means, see deprecation policy definitions

→ To help you migrate to an alternative solution (if applicable), see migration guides.

Solution Deprecation date Sunsetting date
Single property owner (SPO) flow September 15, 2021 April 1, 2022
Photos via Content API September 15, 2021 April 1, 2022
One past stay (Guest Requirement) September 15, 2021 April 1, 2022

Detailed overview of deprecating solutions

This section provides more in-depth information on what deprecates with(in) an affected solution. hotel

SPO flow deprecates the SPO flow, which refers to:

→ To learn more about the alternative solution, see the Contracting API documentation.

Photos via Content API deprecates managing photos using the Content API, which refers to:

→ To learn more about the alternative solution, see the Photo API documentation.

One past stay deprecates using the GuestInformation/@RequireMinimumStay element stating the guest should have had at least one stay, which refers to:

For this element, there exists no alternative solution.

Key definitions

This section covers the definitions for all concepts related to deprecation.

  • Solution: From here on, solution refers to any API product, feature, or service provides to you via the Connectivity platform. In practice, this often refers to an entire endpoint, part of an endpoint, or just one attribute.
  • Deprecation: Deprecating a solution means no longer intends to improve or update that solution, and also that no longer actively supports (technical and commercial support) its usage, implementation, and improvement. You can still use it, but are strongly encouraged to move to an alternative solution. can still fix business critical bugs (breakage that could impact your business continuity) related to the deprecated solution.
  • Sunsetting: Sunsetting a solution means that no longer enables you to use it, which basically means the solution is no longer available.
  • Deprecation announcement: This is the moment communicates to you the deprecation and sunsetting plans for (a) solution(s). intends to announce this in a timely manner so that you can plan ahead and implement the alternative solution (if applicable).
  • Deprecation date: Refers to the moment in time in which the deprecation of (a) solution(s) starts.
  • Deprecation period: Refers to the time period in which a solution is deprecated.
  • Sunset date: Refers to the date (end of deprecation period) in which pulls the plug on a solution. This means no longer enables you to use the solution.
  • Migration guide: Refers to documentation that aims to support you in migrating to the alternative solution (if applicable) when a solution is deprecated.
  • Deprecation timeline: The deprecation timeline consists of the deprecation date, sunset date, and documentation removal date.
  • Documentation archival: Any supporting documentation for the solution is now archived. This is the end of the deprecation process.

Deprecation timeline (example)

To understand the deprecation timeline, see the following figure (with more detailed steps below):


  1. informs you when which solutions deprecate and become sunset. For this we use multiple communication channels: Release cycle newsletter, dedicated documentation section, Salesforce Communities, and the provider portal.
  2. After communication, we create migration guides or other information resources to help you migrate to the alternative solution (if applicable).
  3. A month before deprecation we send you reminders via the newsletter and Communities. We encourage you to already start making plans to prepare the changes within your systems or interface.
  4. On the deprecation date we stop supporting the deprecated solutions, unless they are business critical. (For example, photos via Content API are blocked from being uploaded is business critical, while longer waiting time for processing uploads is not.) Relevant pages in the documentation carry a banner with a note of deprecation. API responses also include warnings with deprecation messages.
  5. During the deprecation period we send targeted reminders to ensure you are aware and are able to mitigate the impact of the deprecation. When in trouble, please reach out to support. They can still help with implementation of the alternative solution (if applicable).
  6. On the sunset date, we remove all functionality, which makes the solution unusable. API responses now throw errors.
  7. To end the cycle, we archive the documentation and remove any instances where the solution is present (such as the partner programme).

API deprecation warnings

Deprecation warnings

Starting the day of the deprecation, all affected API endpoints return (a) warning(s):

  • For cases when it concerns the deprecation of an entire endpoint, the warnings are in the header.
  • For cases when it concerns a partial deprecation of an endpoint, you can find deprecation warnings in the <warnings> or "warnings" array in the response body.

Need help?

If a solution deprecation affects you, we can support you with migrating to the alternative solution or provide insights in how to mitigate the impact of the changes on your internal set-up. If you feel you need more support, do not hesitate to reach out to Connectivity Support or your contact person.