IN
INFYNIA

Versions and deprecation

What stays stable in v1, what can change, and how a deprecation is announced.

Version in the URL

The version is part of the path: /api/v1/.... Version 1 is stable.

Changes that do not break v1

  • New endpoints, new optional parameters and new fields in responses.
  • New error codes and new webhook event types.
  • New values in a list of values such as a status.

Write your client to ignore fields it does not know, and to handle an unknown error code or event type by default instead of failing.

Breaking changes

A breaking change is only released in a new version (/v2). The previous version keeps working for at least 6 months after the announcement.

Announcing a deprecation

A deprecated route keeps answering normally and adds standard headers to every response: Deprecation (RFC 9745), Sunset (RFC 8594) with the end date when it is known, and a Link header pointing to the migration documentation. Monitor these headers in your client to be warned early.

Deprecation: @1767225600
Sunset: Thu, 01 Oct 2026 00:00:00 GMT
Link: <https://example.com/developers/guides/versions>; rel="deprecation"; type="text/html"