Skip to main content
POST
Add a route to an instance

Authorizations

Authorization
string
header
required

Runtime context-key (rctx_*) issued by the Ravi gateway. Required for every non-open scope. Bootstrap the first key with ravi daemon init-admin-key; rotate, derive, and revoke via the ravi context family. Specs: runtime/context-keys, sdk/auth.

Body

application/json
agent
string
required

Agent ID

name
string
required

Instance name

pattern
string
required

Route pattern (e.g., group:123456, 5511*, thread:*, *)

allowRuntimeMismatch
boolean

Allow mutation even when the CLI bundle differs from the live daemon runtime

channel
string

Limit route to a specific channel (e.g. whatsapp, telegram). Omit for all channels.

dmScope
string

DM scope override

policy
string

Policy override: open|pairing|closed|allowlist

priority
string

Route priority (default: 0)

session
string

Force session name

Response

Success — no @Returns schema declared; payload shape is loose.

The response is of type object.