Skip to main content
POST
/
api
/
{session}
/
groups
/
{id}
/
participants
/
remove
Remove participants
curl --request POST \
  --url https://{host}/api/{session}/groups/{id}/participants/remove \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "participants": [
    {
      "id": "[email protected]"
    }
  ]
}
'
{
  "success": true,
  "message": "Participants removed successfully"
}

​
Description

This endpoint allows removing participants from a group.

​
URL Parameters

​
session
string
required
WhatsApp unique session ID
​
id
string
required
Group ID in format [email protected]

​
Body

{
  "participants": [
    "[email protected]"
  ]
}

​
Body Parameters

PropertyTypeRequiredDescription
participantsarray✅ YesArray of JIDs of the participants to be removed. Format: ["[email protected]"]

​
Response

{
  "success": true,
  "message": "Participants removed successfully"
}

​
Status Codes

  • 200 - Participants removed successfully
  • 400 - Invalid parameters
  • 401 - Unauthorized
  • 403 - No permission (admins only)
  • 404 - Group not found

​
Usage Example

curl -X POST https://api.wappfy.com.br/api/my-session/groups/[email protected]/participants/remove \
  -H "Content-Type: application/json" \
  -d '{
    "participants": ["[email protected]"]
  }'

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Path Parameters

​
id
string
required

ID do Grupo

Body

application/json
​
participants
object[]
required

Response

200 - undefined