Skip to main content
GET
Get client rules

Authorizations

Authorization
string
header
required

Scoped API key created via POST /api/account/keys.

Path Parameters

session
string
required

Session name

Response

OK

allowedActions
string

AllowedActions is a comma-separated list of actions client tokens can perform. e.g. "send_message,send_reaction,send_typing,send_seen,read_presence"

Example:

"send_message,send_reaction,send_typing"

allowedOrigins
string

AllowedOrigins is a comma-separated list of origins for CORS enforcement.

Example:

"https://myapp.com,https://staging.myapp.com"

enabled
boolean

Enabled controls whether client tokens are accepted for this session.

Example:

true

maxDaily
integer

MaxDaily is the max messages per day per ephemeral session.

Example:

100

rateLimit
integer

RateLimit is the max requests per minute per ephemeral session.

Example:

5

recipientMode
string

RecipientMode controls who client tokens can message. "conversation" = only reply to JIDs that messaged first. "any" = no restriction. "verified" = only message verified JIDs (future). "none" = read-only, no sending.

Example:

"conversation"