SSoftLinkSMSDocs

Versioning

What we may change without notice, and what we never break.

The API version is in the path: /api/v1. Within v1, we only make backwards-compatible changes.

Safe changes, without notice

Your integration should handle these:

  • New endpoints.
  • New optional request fields and headers.
  • New fields in responses and webhook payloads. Ignore fields you don't recognise.
  • New code values, new event types and new enum values. Treat unknown values gracefully.
  • Reworded message text in errors.
  • Changes to the order of fields in JSON.

Breaking changes

These only ever come in a new version (/api/v2), announced at least 90 days before the old version changes:

  • Removing or renaming an endpoint, field or code.
  • Making an optional field required.
  • Changing a field's type or meaning.
  • Changing how authentication or signatures work.

Every change is listed in the changelog.

Message lifecycle

Every status a message can have, and what moves it on.

Changelog

Every change to the API, newest first.

On this page

Safe changes, without noticeBreaking changes