# API versions & change tracking.

- Canonical URL: https://www.broadnet.me/developers/api-versioning
- Language: en
- Last updated: 2026-10-21
- Publisher: BroadNet (https://www.broadnet.me)
- Markdown version of the page above, generated from the rendered page.

Policy· /api-versioning

BroadNet API paths carry no version prefix: you call https://api.broadnet.me/sms/sendSms, not a /v1 path. Changes are tracked in two places: the version field of the OpenAPI spec, and the semantic version of the TypeScript SDK on npm.

3 min read · Updated September 2026 [Developer Hub](https://www.broadnet.me/developers)

On this page

## Overview

BroadNet API paths carry no version prefix: you call https://api.broadnet.me/sms/sendSms, not a /v1 path. Changes are tracked in two places: the version field of the OpenAPI spec, and the semantic version of the TypeScript SDK on npm.

## Where versions live

The OpenAPI 3.1 spec at /developers/openapi.yaml records its version in info.version. The official SDK, @broadnet/cpaas-sdk, follows semantic versioning on npm: a new major version signals a breaking change to its generated method names or types.

Pin the SDK version in package.json and upgrade deliberately, after reading the release notes and running your tests.

## Build tolerant clients

Most API changes add something: a new endpoint, a new optional field, a new status value. Write your integration so that additions are harmless.

Ignore what you don't know

Ignore unknown JSON fields instead of failing on them, and don't assume a list of statuses is closed. That habit keeps additive changes invisible to your code.

## Staying informed

- Watch the changelog for dated API changes.
- Diff the OpenAPI spec between downloads: a diff of the spec is a diff of the API.
- Pin @broadnet/cpaas-sdk to an exact version and read its release notes before upgrading.

## Related documentation

[API changes Changelog /developers/changelog](https://www.broadnet.me/developers/changelog) [Reference API reference /developers/api](https://www.broadnet.me/developers/api) [Reference OpenAPI spec /developers/openapi](https://www.broadnet.me/developers/openapi) [Reference Error format /developers/error-codes](https://www.broadnet.me/developers/error-codes)

Build on the wire

## Test access within one business day.

[Request test access](https://www.broadnet.me/signup) [Back to docs](https://www.broadnet.me/docs)