This is the running log of breaking changes — anything that could require action from an API consumer or integration. Each entry lists what changed, when it takes effect, and what to do. As of the latest release, there are no active breaking changes pending.
What counts as breaking
A breaking change is anything that can break an existing integration if you do nothing: removing or renaming an API field, changing a response shape, tightening validation, or altering default behavior. Additive changes (new optional fields, new endpoints) are not breaking and aren't logged here.
How breaking changes are handled
We announce breaking changes ahead of time with a deprecation window, keep the old behavior working through that window, and document the migration. Handle errors by stable code, not message, so message wording changes never break you (see API error codes reference).
Current status
No breaking changes are currently pending. When one is scheduled, it appears here with an effective date and a migration note, and is emailed to release-notes subscribers.
If a change affects you
Follow the migration note in the entry, test against the new behavior before the effective date, and contact support with your request_id if you hit a problem during migration.