Skip to content

API change policy

First Delivery aims to preserve existing integrations within a published API version.

Compatible changes may ship without a version change, including:

  • new optional request fields;
  • new response fields;
  • new webhook event types;
  • new enum values where the contract is documented as extensible;
  • additional error detail.

Clients must ignore unknown response fields and webhook event types. Avoid exhaustive parsing that fails when an enum grows.

Breaking changes require a migration path and notice. Deprecated routes remain documented during their migration window, with the replacement and removal date when one is scheduled.

The generated reference is built from the published Postman collections. Collection changes are checked against the API-client scope registry so a documented route is not accidentally inaccessible to scoped clients.