Deprecations

Deprecations are features of the API which you are discouraged from using, even though they may still be supported for a period of time for the sake of backwards compatibility. Such features are normally deprecated because they are superseded by a better alternative. They can include object properties or entire API operations. The list of deprecations is as follows. Individual items are also highlighted in the Changelog when they occur. Historic deprecations that have already been discontinued may not be listed.

For more information, see our Deprecations Policy.

Important: We strongly advise you to review this list and if you are using any of the deprecated items in your integration, to update your implementation accordingly.

The table columns have the following meanings:

Object - JSON data object containing the deprecated field or property
Property - Field or property which is deprecated
Replaced by - What the replacement is, if applicable
Context - The context in which the property is used, usually the API operation
Deprecated - The date at which the deprecation notice was given (see the Changelog)
Discontinued - The date at which it is planned to discontinue the feature completely; a value of '-' indicates no date has been set