1. Scayle Resource Center
  2. API Reference
  3. Getting Started
  4. Versioning

Versioning

The Omnichannel Add-On API uses URI versioning.

For example, in https://{{tenant-space}}-omnichannel.addon.scayle.cloud/v1/ the current version is v1.

Whenever making a request to the Omnichannel Add-On API, you have to specify the version inside the URI.

Backwards-Compatible Changes

When backwards-compatible changes are made to the Omnichannel Add-On API no new version is released. Backwards-compatible changes include the following:

  • Adding new API resources.
  • Adding new optional request parameters.
  • Adding new properties to responses.

Backwards-Incompatible Changes

When backwards-incompatible changes are made to the Omnichannel Add-On API, a new version is released. Backwards-incompatible changes include the following:

  • Deleting existing API resources.
  • Adding new required parameters to existing API methods.
  • Removing properties from an existing API response.
  • Changing data types of existing properties.