Skip to main content
POST
Create a new instance

Authorizations

Authorization
string
header
required

Runtime context-key (rctx_*) issued by the Ravi gateway. Used by ordinary gateway operations; not accepted by Console-only operations. 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
name
string
required

Instance name (e.g., main, vendas)

agent
string

Default agent for this instance

channel
string

Channel type (default: whatsapp)

contactIntakeMode
string

Inbound DM contact intake: off|discovered|pending (default: off)

dmPolicy
string

DM policy: open|pairing|closed (default: open)

groupPolicy
string

Group policy: open|allowlist|closed (default: open)

Response

Success — body conforms to the @Returns schema.

{key}
any