Skip to main content
POST
Create group

Authorizations

Authorization
string
header
required

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

Path Parameters

session
string
required

Session name

Body

application/json

Group parameters

name
string
required

Initial group name

Example:

"My Group"

participants
string[]
required

JIDs of initial group members

session
string
required

Session identifier

Example:

"default"

Response

OK

createdAt
integer

Unix timestamp when the group was created

description
string

Group description text

id
string

Group JID (e.g. "120363012345678901@g.us")

name
string

Group name/subject

ownerLid
string

LID of the group owner/creator

participants
object[]

List of group members