Versioning

The API version lives in the URL path, baked into the base URL https://api.boostmail.app/v1. There is no version request header and no Accept-based version negotiation: the path is the only place the version appears.

What to expect from /v1

Within /v1, BoostMail may still add things over time: optional request fields, optional response fields, new endpoints, or new enum values. Build your client to tolerate that growth:

• Ignore response fields you do not recognize.
• Do not treat an unrecognized enum value as an error. Branch on the values you know, and fall back gracefully on anything else.

A breaking change, one that is not additive in this sense, would ship as a new major version at a new path, for example /v2, not as a change inside /v1.

Note

This is guidance for building a resilient client, not a published compatibility contract. BoostMail has not published a formal deprecation or sunset policy for API versions.