Deprecation process

Occasionally, API functionality becomes outdated, and we decide to remove it and, if beneficial, replace it. To start this process, we mark the functionality as deprecated in the API documentation.

With each deprecation, we make a best effort to identify affected functionality, explain the reason for the deprecation, estimate when the functionality will become obsolete, recommend alternatives (if any), and provide guidance on migrating from the functionality. We detail all of this in the API changelog.

While deprecated but before the sunset date (described next), the functionality is still available but not recommended. The deprecation period is the best time to migrate from the deprecated functionality. If we are providing a new alternative to the functionality, we describe it in the changelog entry.

When a functionality becomes obsolete, we remove it and its documentation and add a changelog entry indicating that the functionality has been sunset.

For assistance migrating from a deprecated or obsolete functionality, please contact Support.