Skip to main content

Generate a new Chat Token

Generate a Chat Token to be used to authenticate clients to the Chat Service.

Permissions

The API token must include the following scopes: Chat.

Request Body REQUIRED
ttl integer REQUIRED

The maximum time, in minutes, that the access token will be valid for. Between 1 and 43,200 (30 days).

channels object REQUIRED

Each channel with write and read objects with boolean as values. Max of 500 channel inside main channels. Either read, write, or both are required inside each channel and default to false. Each channel name can be up to 250 characters. Must be valid JSON.

member_id string

The unique identifier of the member. Up to 250 characters. If not specified, a random UUID will be generated.

state object

An arbitrary JSON object available to store stateful application information in. Must be valid JSON and have a maximum size of 2,000 characters.

Responses
200

OK

Schema OPTIONAL
token string OPTIONAL

A Chat Token to be used to authenticate clients to the Chat Service.

422

Unprocessable Entity. You may have specified invalid parameters.

Schema OPTIONAL
type string
code string
message string
attribute string OPTIONAL
url uri