Versioning
API versioning is a critical part of managing your integration with Mambo. It ensures your applications continue to function while allowing the platform to evolve.
When we make changes to the API which would break your integrations, we release a new API version. However, we don't automatically change your version. Instead, you decide when to upgrade, minimising disruptions and giving you time to plan.
How versioning affects your integration
Your API version determines the way the platform behaves with your integration:
- It dictates the properties you will send in requests and those you will receive in responses
- It affects the structure of webhook payloads
- It determines which features are available to your integration
Your version is set when your account is first created, and remains stable until you choose to upgrade.
Viewing version information
Once you're ready to upgrade, you can do so from the API Version page, where you will be able to update the Mambo version used for API requests and responses as well as webhook endpoints.
Keep in mind that webhooks allow you to use the account version or to send requests using the latest available version.
Non-breaking changes
The following changes are considered to be non-breaking and won't require a new version:
- Adding new API endpoints
- Adding new optional parameters to existing API endpoints
- Adding new optional properties to existing API requests
- Adding new properties to existing API responses
- Changing the order of properties in existing API responses
- Changing the length or format of system strings, such as IDs, error messages, and other human-readable strings
- Adding new event types to Webhooks