Meta
Deprecation Policy
How we handle breaking changes and API version lifecycle.
Our commitment
We know that breaking changes disrupt your integration. Our policy is designed to give you plenty of time to adapt:
6 months minimum notice
Before any breaking change takes effect, we announce it at least 6 months in advance via email, dashboard notification, and changelog.
Backward-compatible additions
New endpoints, optional request fields, and new response fields are added without breaking existing integrations.
Deprecation headers
Deprecated endpoints include a Deprecation header and Sunset header with the removal date.
Version lifecycle
Fully supported. All features available. Bug fixes and security patches applied.
Still functional but no new features. Migration guide provided. 6+ months until removal.
Endpoint returns 410 Gone with migration instructions. Removed after sunset period.
What counts as breaking
Breaking changes (require new version):
- Removing or renaming an endpoint
- Removing or renaming a required request field
- Changing the type of a request or response field
- Removing a response field
- Changing authentication requirements
Non-breaking changes (backward-compatible):
- Adding a new endpoint
- Adding an optional request field
- Adding a new response field
- Adding a new enum value
- Improving error messages
Current versions
| Version | Status | Released | Sunset |
|---|---|---|---|
| v1 | Active | 2026-06-18 | — |