Skip to main content
POST
/
api
/
{session}
/
groups
/
{id}
/
participants
/
remove
Remover participantes
curl --request POST \
  --url https://{host}/api/{session}/groups/{id}/participants/remove \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "participants": [
    {
      "id": "123456789@c.us"
    }
  ]
}
'
{
  "success": true,
  "message": "Participantes removidos com sucesso"
}

​
Descrição

Este endpoint permite remover participantes de um grupo.

​
Parâmetros de URL

​
session
string
required
ID único da sessão WhatsApp
​
id
string
required
ID do grupo no formato 120363XXXXX@g.us

​
Body

{
  "participants": [
    "5511999999999@s.whatsapp.net"
  ]
}

​
Parâmetros do Body

PropriedadeTipoObrigatórioDescrição
participantsarray✅ SimArray de JIDs dos participantes a serem removidos. Formato: ["5511999999999@s.whatsapp.net"]

​
Resposta

{
  "success": true,
  "message": "Participantes removidos com sucesso"
}

​
Códigos de Status

  • 200 - Participantes removidos com sucesso
  • 400 - Parâmetros inválidos
  • 401 - Não autorizado
  • 403 - Sem permissão (apenas admins)
  • 404 - Grupo não encontrado

​
Exemplo de Uso

curl -X POST https://api.wappfy.com.br/api/my-session/groups/120363XXXXX@g.us/participants/remove \
  -H "Content-Type: application/json" \
  -d '{
    "participants": ["5511999999999@s.whatsapp.net"]
  }'

Authorizations

​
apikey
string
header
required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Path Parameters

​
id
string
required

ID do Grupo

Body

application/json
​
participants
object[]
required

Response

200 - undefined