Managing API Changes

Greenlight will make Backward Compatible Changes to the API and deploy those changes as a minor release. You can find all changes and deployment dates in our Changelog page.

Backward Compatible Changes (non-breaking changes)

Greenlight considers the following changes to be backwards-compatible and do not require an updated version of our API as they should not disrupt your current integration. Your systems should be configured to accept or ignore these types of changes.

• Adding new API resources. (new endpoint or data object)
• Adding new optional request parameters to existing API methods.
• Adding new properties to existing API responses.
• Changing the order of properties in an existing response.
• Changing the length or format of opaque strings, such as object IDs, error messages, and other human-readable strings.

Backwards-Incompatible Changes (breaking changes)

Greenlight considers the following changes to be Backwards Incompatible changes and will require a new version of our API. You will not be required to upgrade to the latest version immediately, but you should anticipate older API Versions will deprecate and will no longer be supported.

• Renaming a property in a request body or response
• Adding a new required request parameter to an existing method
• Changes to HTTP status code responses
• A new error condition in response to a request parameter value