Versioning
Each AgencyMax API has its own version. The current versions are:
| API | Current version |
|---|---|
| Agency Management | v2 |
| Agent Onboarding | v1 |
| Business Insights | v1 |
| Identity Management | v1 |
| Webhooks | v1 |
Non-breaking changes
We can make these changes without a new API version:
- Adding operations or resources.
- Adding optional request properties or query parameters.
- Adding response properties.
- Adding values to enumerations.
- Adding new webhook event types.
- Changing the text of error messages.
- Fixing bugs so behavior matches the documentation.
Build your integration to cope with all of these. In particular, ignore unknown JSON properties and handle unknown enum values.
Breaking changes
Breaking changes, such as removing or renaming a field, changing a type or making an optional field required, come with a new major version. The previous version stays available for a published deprecation period. Deprecations are announced in the Release Notes and on the Blog.
Release notes
Every API release is listed in the Release Notes with details of what changed.