Versioning

The version is in the path: https://api.digitalagency.tools/v1. Within /v1, we only make changes that cannot break a well-behaved client.

Changes we make without notice

These are additive. Write your client to tolerate them:

New endpoints, and new optional query parameters or request fields.
New fields in responses, and new keys in meta.
New error.type values (handle unknown ones by HTTP status).
New webhook event types (you only receive the ones you subscribed to, unless you chose *).
New values in an open-ended string field, such as a pipeline status the business adds.
Changes to the wording of error.message, and to the order of object keys.

Breaking changes

Removing or renaming a field or endpoint, changing a type, making an optional input required, or changing what a status code means is a breaking change. It only happens in a new version (/v2), and /v1 keeps working alongside it.

Deprecation policy

A deprecation is announced in the changelog and marked deprecated in the reference.
Owners of businesses whose keys still call it are told by email and in the panel.
It keeps working for at least 12 months after the announcement.

Security fixes are the one exception: if an endpoint leaks data or can be abused, we fix it immediately and explain in the changelog.