ImportantLobyco may introduce changes without prior notice if the change is non-breaking or if the change addresses urgent issues such as security vulnerabilities, legal requirements, or critical bugs.
Definition
What is a Breaking Change?
A breaking change is any change that requires modification to your application to avoid integration issues or service disruption. Examples include:- Removal of an existing parameter, request field, or response field.
- Changes to permission scopes or access definitions.
- Addition of a required parameter or field with no default value.
- Changes to endpoint behavior or functionality.
e.g., an endpoint that previously archived an object now deletes it. - Modifications to validation rules.
- Introduction of new mandatory validations.
- Changes in data formats (e.g., data type from string to object).
- Throttling policy updates or reduced rate limits.
What is a Non-Breaking Change?
A non-breaking change is one that your integration can adapt to without mandatory updates, and it will not cause service failure. Examples include:- Addition of new optional fields or parameters.
- New fields in responses.
- Addition of new endpoints or methods.
- New validation rules that apply only to new fields.
- Changes to response order (fields, arrays) that do not affect structure.
- Field or method deprecation without removal.
- New enum values in optional parameters.
Notification Policy
When a breaking change is planned:- We will maintain two versions of the affected API for a minimum of 6 months, when feasible.
- We will provide notice through:
- The Breaking Changes timeline on this site and its RSS feed
- Email notifications to customers
- Urgent changes due to legal or security concerns may be rolled out immediately, with notification following soon after.