Skip to main content
POST
Create group

Authorizations

apikey
string
header
required

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Path Parameters

instance
string
required

The number's display name in the Pilot Status dashboard.

Body

application/json
subject
string
required

Group name/subject.

Example:

"Equipe de Vendas"

participants
string[]
required

Phone numbers (digits only) to add as members.

Example:
description
string

Group description.

Example:

"Grupo interno da equipe"

profilePicture
string

URL of the group profile picture.

Example:

"https://example.com/group.png"

promoteParticipants
boolean

Promote the added participants to admins.

Example:

false

Response

Success — provider-native response body.

Raw Baileys group metadata of the newly created group (returned by client.groupMetadata).

id
string

Group JID.

subject
string

Group name/subject.

subjectOwner
string

JID of the participant who last set the subject.

subjectTime
integer

Unix timestamp (seconds) when the subject was last set.

size
integer

Number of participants.

creation
integer

Unix timestamp (seconds) when the group was created.

owner
string

JID of the group owner/creator.

desc
string

Group description text.

descId
string

Identifier of the current description.

restrict
boolean

If true, only admins can edit group info.

announce
boolean

If true, only admins can send messages (announcement group).

isCommunity
boolean

Whether this group is a community parent.

isCommunityAnnounce
boolean

Whether this is a community announcement group.

joinApprovalMode
boolean

Whether new members require admin approval to join.

memberAddMode
boolean

Whether non-admin members are allowed to add participants.

ephemeralDuration
integer

Disappearing-messages timer in seconds (0 when off).

linkedParent
string

JID of the linked community parent, when applicable.

participants
object[]

Group participants.