Skip to content
snapcasterDevelopers

API versioning

Current API version: 2026-07

The partner API is one stream of dated versions covering every endpoint and webhook event family together. The v1 segment in the base URL is a frozen alias and is not the version mechanism.

Your Platform pin

Section titled “Your Platform pin”

Every Platform is pinned to one supported dated API version. Requests authenticated with its Sellers’ Marketplace API keys and webhook Deliveries are serialized at that pin. A Snapcaster release therefore does not silently change the bytes your integration parses.

Moving the pin is an operator-run, two-sided migration. Validate the target version with the override header, then email info@snapcaster.gg to move the pin. Deliveries already in flight keep the version frozen when they were enqueued.

Test with the request override

Section titled “Test with the request override”

Send X-Snapcaster-Api-Version: <version> on one request to render only that response at the named supported version. The override never changes the Platform pin or any webhook. An unknown or retired version returns 400 UNSUPPORTED_API_VERSION and names the supported set.

Test one sandbox request at the current API version
curl --request GET \
  --url 'https://api-sandbox.snapcaster.ca/api/v1/marketplace/me' \
  --header "Authorization: Bearer $MARKETPLACE_API_KEY" \
  --header 'X-Snapcaster-Api-Version: 2026-07'

Webhook versioning

Section titled “Webhook versioning”

Every webhook envelope includes api_version. Log it and route on it if your integration supports more than one version during migration. Retries of one event_id keep the same API version and byte shape.

Compatible and breaking changes

Section titled “Compatible and breaking changes”

New optional fields, new endpoints, and new event types are additive and arrive on every supported version. Treat payloads as open and ignore fields you do not recognize.

Removing or renaming a field, changing its type or meaning, or making a value newly required cuts a dated version. The Platform pin shields you from that change until you deliberately upgrade.

Supported versions retire only after every partner has upgraded, with at least 90 days’ written notice. The changelog records required action and migration instructions.

Need help?

Email Marketplace support with this page and the sandbox environment prefilled.

Never include an API key or Signing secret in the message.