POST
/
wa
/
instances
/
{instance_id}
/
groups
Criar Novo Grupo
curl --request POST \
  --url https://api.zapsterapi.com/v1/wa/instances/{instance_id}/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My New Group Name",
  "participants": [
    "+1234567890",
    {
      "recipient": "+1234567890",
      "role": "admin"
    }
  ],
  "description": "My New Group Description",
  "is_announcement": true,
  "is_restricted": true,
  "approval_mode": "auto_approve",
  "invite_mode": "admins_only",
  "profile_picture": "https://images.unsplash.com/photo-1735956908173-8c9cfdf546e1?q=80&w=256&h=256&auto=format&fit=crop"
}'
{
  "description": "My group description",
  "id": "120363279776130958",
  "invite_code": "XobOM8UBL8EXR3dXoGozql",
  "is_community": true,
  "is_announcement": true,
  "is_restricted": true,
  "approval_mode": "requires_approval",
  "name": "My group name",
  "owner": {
    "id": "558796139874",
    "name": "Owner Name",
    "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
  },
  "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
  "total_participants": 2
}
Este endpoint permite a criação de grupos no WhatsApp. Para criar um grupo, apenas o campo name é obrigatório. Os demais campos como foto de perfil, descrição e participantes são opcionais. Após a criação, você pode modificar qualquer um destes campos utilizando o endpoint de Atualizar um Grupo.

​
Foto de Perfil

Para definir uma foto de perfil durante a criação do grupo, utilize o campo profile_picture. Este campo aceita tanto uma URL quanto uma string em formato base64 contendo a imagem. Recomendamos fortemente o uso de URLs ao invés de base64, pois é uma prática mais eficiente e adequada, especialmente para arquivos de maior tamanho. Embora o formato base64 seja suportado, seu uso pode impactar negativamente a performance da requisição.

​
Participantes

Para adicionar participantes durante a criação do grupo, utilize o campo participants. Os números informados neste campo serão automaticamente adicionados como membros após a criação do grupo ser concluída.
Importante: Para adicionar participantes ao grupo, é necessário que:
  1. O usuário tenha configurado a opção “Who can add me to groups” como “Everyone” nas configurações de privacidade do WhatsApp, ou
  2. O usuário tenha a instância salva como contato
Caso contrário, o usuário só poderá entrar no grupo através de um link de convite.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
instance_id
string
required

ID da instância onde o grupo de encontra.

Body

application/json
​
name
string

Nome do grupo. Deve ter pelo menos 3 caracteres.

Minimum length: 3
Example:

"My New Group Name"

​
participants
array

Lista de participantes a serem adicionados ao grupo. Pode ser uma lista de números de telefone ou objetos com número e função. Máximo de 100 participantes.

Maximum length: 100
Example:
[
  "+1234567890",
  {
    "recipient": "+1234567890",
    "role": "admin"
  }
]
​
description
string

Descrição do grupo

Example:

"My New Group Description"

​
is_announcement
boolean

Define se o grupo será apenas para anúncios (ninguém pode enviar mensagens, só o dono)

Example:

true

​
is_restricted
boolean

Define se o grupo terá acesso restrito (apenas pessoas autorizadas podem participar)

Example:

true

​
approval_mode
enum<string>

Modo de aprovação de novos membros

Available options:
auto_approve,
requires_approval
​
invite_mode
enum<string>

Define quem pode convidar novos membros

Available options:
admins_only,
all_members
​
profile_picture
string<uri>

Foto de perfil, pode ser uma string no formato base64 ou uma url (publicamente acessível)

Example:

"https://images.unsplash.com/photo-1735956908173-8c9cfdf546e1?q=80&w=256&h=256&auto=format&fit=crop"

Response

200 - application/json

Success

​
description
string
required

Descrição do grupo que também pode ser vista na seção de detalhamento do grupo.

Example:

"My group description"

​
id
string
required

Identificador único do grupo.

Example:

"120363279776130958"

​
invite_code
string | null
required

Código do convite do grupo que pode ser usado para convitar outros usuários.

Example:

"XobOM8UBL8EXR3dXoGozql"

​
is_announcement
boolean
required

Indica se o grupo é apenas para anúncios (ninguém pode enviar mensagens, só o dono).

Example:

true

​
is_restricted
boolean
required

Mostra se o grupo tem acesso restrito (apenas pessoas autorizadas podem participar).

Example:

true

​
name
string
required

O nome dado ao grupo.

Example:

"My group name"

​
owner
object
required
​
profile_picture
string<uri>
required

Profile picture URL of the group.

Example:

"https://zapsterapi.s3.us-east-1.amazonaws.com/..."

​
total_participants
integer
required

Total number of participants in the group.

Example:

2

​
is_community
boolean

Indica se o grupo é uma comunidade (pode ser um grupo de anúncios).

Example:

true

​
approval_mode
enum<string>

Define como os participantes serão aprovados no grupo.

Available options:
auto_approve,
requires_approval
Example:

"requires_approval"