API keys

Issue an API key

A live key must say what it is for: brandId scopes it to one brand, scope: "account" makes it account-wide. There is no default, because the previous behaviour silently bound the key to whichever brand happened to have an agent first.

A live key needs a brand with an RBM agent behind it — not a carrier-verified one. An unlaunched agent sends real RCS to its accepted test devices, which is exactly what you need before launch.

post/v1/keys

Request

  • Base URL: https://api.cadencercs.com
  • URL: https://api.cadencercs.com/v1/keys
  • Auth: HTTP bearer

Request body

kind'sandbox' | 'live'
brandIdstring

Scopes the key to one brand. Required for a live key unless scope is account.

scope'account'

Account-wide. A leak reaches every brand you own, so prefer brandId.

labelstring

Response

The key, shown once.

api_keystring required
kind'sandbox' | 'live' required
key_prefixstring required
brandIdstring nullable
scope'brand' | 'account' required
reach'test_devices_only' | 'all_recipients'

Live keys only. How far this key actually reaches today.

reach_notestring
notestring

Changes

No recorded changes to this operation across all 1 revision of this API.