Mailbox API 2.0 and Legacy API 1.0
As of June 6, 2019, we no longer offer support for Mailbox API 1.0. If you have existing integrations running on the legacy API, this guide covers all that you need to know about moving to our new Mailbox API 2.0.
In this article
What is Mailbox API 2.0?
Mailbox API 2.0 is the second generation of our API. While the upgrade to OAuth 2.0 was a major focus for this version, we also added a few other improvements to help make the API easier to navigate. To get you started with Mailbox API 2.0, here are a few highlights of the changes:
- We added user-friendly authentication for third party integrations.
- The documentation includes a breakdown of the main differences between V1 and V2.
- We doubled our rate limits.
- If a request fails, we’ll tell you why!
Mailbox API 1.0 is No Longer Supported
Support for legacy Mailbox API 1.0 was discontinued on June 6, 2019. This means:
- We have frozen the legacy code. Even if the API breaks, our team has no plans of deploying any further fixes or updates.
- Documentation for API 1.0 is no longer available
- Third-party integrations still running on the legacy API cannot be freshly installed
- Users can no longer generate new API keys
- Our support team is not able to lend a hand with legacy Mailbox API 1.0 questions
If you have any custom or third party integrations still using the legacy API, they will need to be updated to use the new API. We plan to disable the legacy API completely in the coming weeks. While your existing 1.0 integration may not stop working immediately, we can't guarantee that it will continue to work in the future.
Third-Party Integrations: Our friends at AgileCRM, CloudTalk, Fivetran, Klaviyo, and Teckst are all busy working through their Mailbox API 2.0 migrations as we speak. Not to worry, these integrations will continue to function as our partners work to update and launch their code.
What stayed the same?
Our Docs API, Webhooks, and Custom Static and Dynamic apps all use different systems behind the scenes. There were no changes made to these features as a result of the Mailbox API 1.0 sunset.
Update to Mailbox API 2.0
If you’ve built an integration using the legacy API, you will need to update it to Mailbox API 2.0. At a high level, your migration plan will need to tackle two things:
- Update all API calls to use the new Mailbox 2.0 endpoints.
- Update your integration’s authentication method to use OAuth 2.0.
Bonus points: If you've developed a third party integration using the legacy API and would like to migrate users to the new API automatically behind the scenes, we built a handy transition tool just for you.
If you have any questions or concerns about moving to Mailbox API 2.0, please don’t hesitate to reach out.