Actions51
- API Actions
- Chat Actions
- Contact Actions
- Group Actions
- Instance Actions
- Message Actions
- Message Queue Actions
- Product Actions
- Status Actions
Group → Remove Participant
AI-generatedSummary
Remove specified participants from a WhatsApp group.
Inputs
- groupId (required) — The group identifier (e.g., 120363019502650977-group).
- participants — Collection of participant phone numbers to remove; each phone must be in international format (digits only).
Output shape
HTTP response object from the Z-API remove-participant endpoint (typically includes success status or error details).
The exact body varies; on success it returns the API's response payload, which may contain confirmation data. Errors are thrown as node errors.
Examples
Example 1: Remove two users from a group.
groupId: 120363019502650977-group; participants: [{ phone: 5544999999999 }, { phone: 5544888888888 }]