API changes and versioning
StableHow SnapAddress changes its API: what we change without notice, what we announce in advance, and how you'll hear about it.
Our commitment
You build on SnapAddress, so changes shouldn't surprise you. Every change is published in the changelog, and anything that could change what your integration receives is announced before it happens.
We sort every change by its effect on an existing integration:
| Type of change | Examples | Notice |
|---|---|---|
| New capabilities | New endpoints, new fields, new optional parameters, results for input that used to return nothing | None — published in the changelog when live |
| Corrections | A value that was wrong is made right | None — published in the changelog when live, under "changes that may affect your integration" |
| Format changes | An existing field returns different formatting or values — for example, casing or whitespace | At least 7 days, by email to accounts using the affected endpoints, and in the changelog |
| Breaking changes | A field or endpoint removed or renamed, a type or meaning changed, authentication or billing changed | At least 30 days. Where possible we release a new API version and keep the current one running alongside it. |
Changes needed for security, legal or Royal Mail licence reasons may take effect immediately; we'll tell you the same day.
How you'll hear
- The changelog lists every change, newest first. Upcoming changes appear there from the day they're announced, with the date they take effect.
- Email goes to your account's email address when a format or breaking change affects an endpoint you use. These are service messages, sent regardless of your marketing preferences.
Building for change
New fields can appear in responses at any time. Ignore fields you don't recognise rather than rejecting the response, and your integration will keep working through every additive change.