Versioning & deprecations

Updates to Bud's API documentation are made frequently.

Please see the Changelog for a list of all changes that have been made to Bud’s API documentation. This includes both backward-compatible and backward-incompatible changes.

Backward Compatibility

Bud aims to make integration as seamless as possible for its clients and therefore takes all possible steps to prevent backward-compatibility breaks. In the scenario where a backward-compatibility break is unavoidable, Bud creates a new endpoint, either: (a) by bumping the version within the endpoint URL; or (b) in some circumstances renaming the URL entirely. The previous endpoint may then become deprecated, and support for the endpoint will cease after a period of three months. Clients with access to any of Bud’s API services will be notified of deprecations to any endpoints and provided with ample time in which to make any necessary changes.

Fields within a response or request schemas may also become deprecated. Along with deprecated endpoints, these breaking changes will be clearly highlighted within the changelog.


Bud will continue to support deprecations for a period of three months after they are first announced.

Please see the Changelog for a list of all deprecated endpoints.

If you have any questions, please contact us via the chatbot (bottom-right of screen 👉) or via a support request or check our FAQs.