Versioning▾
Versioning
Date-based versions, what counts as breaking, and how to upgrade.
The URL is pinned at /v1. Behavioural changes ship as dated versions selected with a header. Your account has a default version, set the first time you call the API.
cURL
-H "Sendport-Version: 2026-09-01"What we consider breaking
| Change | Breaking? |
|---|---|
| Adding a response field | No |
| Adding an optional request field | No |
| Adding a new enum value | No — parse defensively |
| Removing or renaming a field | Yes |
| Changing a field's type | Yes |
| Making an optional field required | Yes |