Migrating to Mailbox API 2.0

The day is finally here! Mailbox API 2.0 is officially available for use. This guide covers all that you need to know about the new API and how to transition any existing integrations from our legacy API to 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’ve 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: 

Sunsetting Mailbox API 1.0

With Mailbox API 2.0 now publicly available for use, we’ll be officially switching off Mailbox API 1.0 (formerly known as Help Desk API) on Jun 6th, 2019. If you have any custom or 3rd party integrations using the legacy API, they will need to be updated to the new version within the next year. 

While your update to Mailbox API 2.0 is in progress, it’s important to note that Mailbox API 1.0 will continued to be supported in a maintenance capacity. That means that all integrations running on the legacy API and all legacy API keys will continue to function normally throughout the next year. If an integration requires a Help Desk API key, you’ll still be able to generate one from your User Profile until June 6th, 2019.

Which integrations are impacted?
Any official integrations using legacy API keys, custom-built integrations, and open source projects using Mailbox API 1.0 will all need to be migrated over to the new API within the next year. If you’re unsure whether an integration that you’re using falls into this boat, here’s a list of our official integrations that use legacy API keys:

AgileCRM Elevio Klaviyo Smooch Textline
Aircall Gravity Forms Nicereply Sprout Apps Userlike
Chatra Help Desk Migration Piesync TalkDesk WooCommerce
ClickDesk JustCall Segment.io Teckst WordPress

Rest assured, while migration to Mailbox API 2.0 may take some time to complete, these integrations will be business as usual until June 6, 2019.

What’s staying the same?
Our Docs API, Webhooks, and Custom Static and Dynamic apps all use different systems behind the scenes, meaning there won’t be any changes made to these features as a result of the Mailbox API 1.0 sunset.

Updating your integration to Mailbox API 2.0

If you’ve built an integration using our Mailbox API 1.0, now’s the time to start updating your apps so you don’t experience any interruptions down the road. At a high level, your migration plan will need to tackle two things:

  1. Update all API calls to use the new Mailbox 2.0 endpoints.
  2. Update your integration’s authentication method to use OAuth 2.0.

Bonus points: If you have an existing Help Scout integration using the legacy API and would like to migrate users to the new API behind the scenes, we built a handy transition tool just for you.

If you have any questions or concerns about Mailbox API 2.0, please don’t hesitate to reach out. We’re here to help with anything we can during this transition period!

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still stuck? How can we help? How can we help?