Skip to main content
POST
Criar grupo

Autorizações

apikey
string
header
obrigatório

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

Parâmetros de caminho

instance
string
obrigatório

O nome de exibição do número no painel do Pilot Status.

Corpo

application/json
subject
string
obrigatório

Nome/assunto do grupo.

Exemplo:

"Equipe de Vendas"

participants
string[]
obrigatório

Números de telefone (apenas dígitos) a adicionar como membros.

Exemplo:
description
string

Descrição do grupo.

Exemplo:

"Grupo interno da equipe"

profilePicture
string

URL da foto de perfil do grupo.

Exemplo:

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

promoteParticipants
boolean

Promover a administradores os participantes adicionados.

Exemplo:

false

Resposta

Sucesso — corpo de resposta nativo do provedor.

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.