Skip to main content
POST
Create a new group

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

Group name/subject

account
string

WhatsApp account ID

admin
string[]

Phone numbers to add and promote as group admins. Can be repeated or comma-separated.

admins
string[]

Alias for --admin

agent
string

Agent to route this group chat to

agentCwd
string

CWD for --create-agent (default: ~/ravi/)

agentModel
string

Runtime model selector for --create-agent

agentProvider
string

Runtime provider id for --create-agent

createAgent
boolean

Create --agent first when it does not exist

execute
boolean

Actually create the group; default is a dry-run that only shows the plan (exit 3)

participants
string

Phone numbers to add (comma-separated); omitted uses current contact actor when available

skipTaggedAdmins
boolean

Do not auto-promote contacts tagged admin

Response

Success — body conforms to the @Returns schema.

{key}
any