We release new API versions when breaking, backwards-incompatible changes are made to the API.
Breaking changes include:
- Removing an endpoint.
- Adding new required request fields, parameters or headers to an endpoint.
- Removing or changing response fields.
- Adding new validation rules to request fields or parameters.
- Updating request fields or query parameters to be required instead of optional.
Non-breaking changes include:
- New endpoints.
- New read-only or optional fields.
- Endpoints or fields marked as deprecated.
- Update human-readable error description.
- New enum constants.
Note: Your code should be able to handle new types of responses. For example, please ensure that you design your code to handle unknown enum types and new fields in responses.