The current version
New businesses are pinned to the latest version automatically.
Send the version with every request
Every request must include theAPI-Version header, set to the version your business is pinned to:
How versions are named
A version is a date and a name:YYYY-MM-DD-name. The date is when the version was released.
Moving to a new version
1
Read what changed
Check the Changelog for what’s different in the new version.
2
Update your code
Update and test your app in the sandbox first.
3
Change the version in the Bridge app
Go to Settings → Integration → API version and choose the new version.
4
Send the new version
Change the
API-Version header your app sends at the same time.How often versions change
We release a new API version every 3 months:1
Month 1
The latest version is the only new version. Nothing changes.
2
Month 2: a new experimental version
We release the next version as experimental. You can try it in the sandbox and send it in the
API-Version header to test your app.3
Month 3: testing
The experimental version is tested for 1 month.
4
The next cycle starts
The experimental version becomes the latest, and the version that was latest moves to stable. Your business stays on its version until you choose to move.
Version lifecycle
A version goes through these stages:Version errors
All of these return400:
Some of these errors include extra fields to help you, such as
requested_version, account_version, or supported_versions.