Pular para o conteúdo principal
POST
/
instances
/
{id}
/
group
/
create
Criar grupo
curl --request POST \
  --url https://api.vzaps.com/instances/{id}/group/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groupName": "<string>",
  "participants": [
    "<string>"
  ],
  "groupDescription": "<string>",
  "groupImage": "<string>"
}
'
{
  "code": 200,
  "success": true,
  "data": {
    "jid": "120363021234567890@g.us",
    "owner_jid": "5511999999999@s.whatsapp.net",
    "owner_pn": "5511999999999",
    "name": "Equipe Vendas",
    "topic": "Pedidos e follow-up",
    "topic_deleted": false,
    "is_locked": false,
    "is_announce": false,
    "is_ephemeral": false,
    "disappearing_timer": 0,
    "group_created": "2025-11-20T14:30:00Z",
    "participant_count": 2,
    "total_participants": 2,
    "is_admin": true,
    "invite_url": "https://chat.whatsapp.com/AbCdEfGhIjKlMnOpQrStUv",
    "participants": [
      {
        "jid": "5511999999999@s.whatsapp.net",
        "phone_number": "5511999999999@s.whatsapp.net",
        "lid": "",
        "is_admin": true,
        "is_super_admin": true,
        "display_name": "Maria",
        "error": 0
      }
    ]
  }
}

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

id
string
obrigatório

Identificador publico da instancia no formato gerado pela plataforma: prefixo VZ seguido de caracteres alfanumericos.

Exemplo:

"VZ9K2M4N8P1Q3R5S7T0WABCD01EF"

Corpo

application/json
groupName
string
obrigatório
participants
string[]
obrigatório
groupDescription
string
groupImage
string

Opcional. URL publica (https://...) ou data URL em base64 (data:image/<mime>;base64,...) para a foto inicial do grupo.

Resposta

200 - application/json

Grupo criado

code
integer
obrigatório
success
boolean
obrigatório
data
object

Metadados de um grupo WhatsApp (subconjunto dos campos; outros podem aparecer).