Guide 11/12

Versioning and deprecation

The version is in the path: /api/v1.

Compatible changes (any time)

• New endpoints, fields, optional parameters, enum values and webhook events.
• Your client must ignore unknown fields and tolerate new enum values.

Breaking changes (only in a new version)

• Removing or renaming fields, changing types or meanings, new required parameters — only in /v2, with /v1 kept in parallel.

Deprecation

Deprecated endpoints answer with Deprecation and Sunset headers at least 6 months before removal, and the change is announced in the changelog.

HTTP/1.1 200 OK
Deprecation: @1798761600
Sunset: Wed, 30 Jun 2027 00:00:00 GMT
Link: <https://anagen.pt/desenvolvedores/guias/alteracoes>; rel="deprecation"