Help centre / Your organisation / For your developers

Choose which API version your systems use

Updated · 1 minute to read Download as PDF

Your organisation stays on one API version until you choose to move, so a change on our side never surprises your systems. When a newer version comes out, you decide when to upgrade.

  1. Open API version

    From All products, open Organisation and then API version. You will see the version you’re on under Pinned, and the newest under Latest.

  2. Read what changes

    If a newer version is out, What changes lists each difference. How to upgrade → explains what your developers might need to update.

  3. Try it first

    Under Test first, there’s an example your developers can use to send the new version on a few requests before anything else moves.

  4. Upgrade

    When you’re ready, select Upgrade to the new version, then Upgrade. Every key and webhook in your organisation moves at once.

  5. Roll back if you need to

    For 72 hours after a change you can select Roll back to the previous version, then Roll back. The page shows how long you have left.

If something goes wrong

You see Stops working next to your version. That version is being retired on the date shown. Upgrade before then, and write to us at [email protected] if you need more time.

The 72 hours have passed and something has broken. Write to us at [email protected] and tell us what’s failing, and we’ll help you sort it out.

Still stuck? Write to [email protected] and we'll get back to you.