Skip to main content

API versions

API versions enable you to specify which Mambo version processes your API requests and responses. This versioning system helps maintain integration stability and provides control over API updates.

Overview

When Mambo releases updates, changes to API request/response structures could impact your integrations. To prevent disruption, version upgrades are not automatic - you choose when to upgrade.

Version management

Current version

Your API version determines:

  • Request/response JSON structures
  • Available endpoints and features
  • Behaviour of API operations

Version changes

Before upgrading:

  1. Review version release notes
  2. Test integrations in a development environment
  3. Update code to handle any structural changes
  4. Migrate gradually using version headers

Best practices

  • Maintain version consistency across integrations
  • Monitor deprecation notices
  • Plan upgrades during low-traffic periods
  • Keep test environments on latest versions

Troubleshooting

Common version-related issues:

  • Unexpected response formats
  • Missing or changed fields
  • Deprecated endpoint calls
  • Authentication errors

For technical details, see the versions section in the API documentation.