Default API Version Now v3
Written by Mailgun Team
Categories: What's New
2 minute read time
This was originally announced on March 23, 2015.
We’ve made several performance and stability enhancements to our API recently. Because of the significance of the changes and also to keep our API consistent, we’re changing the default base URL to /v3.
v3 is backward compatible with v2
No need to change your endpoints. All existing API methods remain backward compatible and keep the same request/response format. However, there will be some behavioral changes in a few of them.
Suppressions API (bounces, unsubscribes and complaints)
We made some significant changes to our suppressions API, which manages your bounces, unsubscribes and complaints.
Everything mentioned below for “bounces” is true for “unsubscribes” and “complaints” as well.
Changes related to /v2
- The current
GET /v2/<domain>/bouncesmethod preserves the same request/response format but effectively becomes an alias for the Events API so will be able to return bounces occurred in the past 30 days only.Due to the way the Events API works, total_count returned via this API call will no longer be accurate and preserved for backward compatibility purposes only.
What’s new in /v3
- The new
GET /v3/<domain>/bouncesmethod used for iterating over all domain’s bounces returns bounce addresses in alphabetical order, so can no longer be used for polling for the most recent bounces. It is also much faster and more stable than its /v2 counterpart when iterating over large lists.
- The new batch upload method lets you upload many bounces in a single API call.
- Tweaks to request/response formats of other suppressions API methods that make for cleaner API in general.
What does this mean for me?
If you’re currently using
/v2/<domain>/bounces API to poll for most recently occurred bounces, you can continue using it but do not rely on total_count. If, however, you need to reliably pull all domain’s bounces, please use
/v3/<domain>/bounces API call.
Most of our customers should be unaffected by these changes. If anything you should experience a performance upgrade with our APIs. If this does affect you feel free to contact our Support team with any questions.
Modified on: March 13, 2019