API versions serve as a bridge between your existing integrations and our latest platform capabilities, allowing you to safely access new features, enhanced security, and performance improvements. Keeping your API up to date ensures your workflows run on the most robust infrastructure we offer, while giving you the flexibility to upgrade on your own schedule without disrupting your current setup.
Step 1: Open API Settings
Navigate to Setup > Company Setup, then click on API Settings.
Step 2: Review your available APIs
Review the list of available APIs alongside the version you are currently using. The icon beside the name of each API links directly to the developer documentation.
Step 3: Check for a new version
Look for a blue Badge beside an API name. This indicates that a new version is available to you. Click the blue badge to view the latest version history.
Step 4: Open the version list
Open the drop-down menu next to the relevant API to view all available versions.
Step 5: Select the version
Select the specific version you want to move to.
Important: Version updates take effect immediately. Version updates take immediate effect upon confirmation. We highly recommend testing new versions in your sandbox environment before completing the upgrade in production.
Step 6: Review the confirmation pop-up
A confirmation pop-up will appear summarising the changes you are about to make.
Step 7: Update or cancel
If you are ready to proceed, click Update version. If you need to back out, click Cancel.