Skip to main content
POST
SDK

Authorizations

Authorization
string
header
required

Voyant Cloud API token, passed as Authorization: Bearer <token>. Each token carries a fixed set of scopes; an operation rejects tokens missing its required scope.

Body

application/json
clientId
string
required

Stable subscriber identity; surfaces as the presence clientId.

Example:

"user_42"

capabilities
object
required

Capability grants keyed by channel name or trailing-wildcard pattern (e.g. admin:*).

Example:
ttlSeconds
integer

Token lifetime in seconds. Default 3600, max 86400.

Required range: x <= 86400

Response

Minted token

token
string
required
expiresAt
string<date-time>
required