Skip to main content

API Upgrades & Versioning

Scoffable periodically releases updates to the API. Most changes are backward-compatible and do not require any changes to your integration.

What is a backward-compatible change?​

Scoffable considers the following changes to be backward-compatible:

  1. Adding new API resources or endpoints.
  2. Adding new optional properties and request parameters to existing endpoints.
  3. Adding new properties to API responses.
  4. Changing the order of properties in API responses.
  5. Changing the length or format of opaque values (e.g., object IDs, error messages, or human-readable strings).

These changes should not break existing integrations and require no action on your part.

Breaking changes​

When Scoffable introduces a breaking change — one that may impact existing clients — we release it under a new API version with a distinct URL path.

For example, to migrate from version 1 to version 2, update your API base path from: /v1 to: /v2

This versioning strategy ensures that existing integrations continue to work without disruption.