- Within v1, changes only add things: new fields, new routes, new widget types and new error codes.
- Ignore what you don’t recognise. Your app must skip fields and widget types it doesn’t know, so a new widget type never breaks an app already in the store.
- Breaking changes mean a new major version, published alongside v1. We support v1 for at least 12 months after its successor ships.
- Retirement is announced in advance. Responses carry
DeprecationandSunsetheaders, and every change is in the changelog.
Get started
Versions and changes
What can change within v1, and how we retire a version.

