The Cooler API is versioned using the URL of the endpoint, for example:

While we endeavor to maintain backwards compatibility, we will version the API when a breaking change in behavior happens in order to prevent compatibility issues. We will maintain older versions of the API which you can continue to use until you are ready to upgrade.

Older versions of the API that we can no longer maintain will be informed of upcoming deprecation 90 days in advance of actual deprecation of a route. Consumers of the API will receive a COOLER-DEPRECATION response header with further information about the endpoint deprecation. Our support team will also reach out directly to API consumers to help transition them to supported endpoints.

We do not expect this to happen often and are fully committed to supporting older versions of the API but in some cases we may have to deprecate routes and want a clear plan of attack for this situation.

Last updated