Actions90
- Sessions Actions
- Messages - Sending Actions
- Chats Actions
- Messages - Actions Actions
- Groups Actions
- List Groups
- Group Info
- Get Invite Link
- Revoke Invite Link
- Join via Link
- Preview via Link
- Create Group
- Delete Group
- Update Group Description
- Toggle Announcement Mode
- List Participants
- Add Participants
- Remove Participants
- Demote Participants
- Approve Join Request
- Reject Join Request
- List Join Requests
- Get Group Picture
- Set Group Picture
- Delete Group Picture
- Leave Group
- Update Group Name
- Lock Group Edits
- Promote Participants
- Profile Actions
- Server Actions
- Miscellaneous Actions
Overview
This node operation removes one or more participants from a specified WhatsApp group using the WARest WhatsApp REST API. It is useful for managing group membership by programmatically removing users from groups, for example, to moderate group membership or automate group management tasks.
Use Case Examples
- Remove a single participant from a group by specifying the group ID and the participant's JID or phone number.
- Remove multiple participants from a group by providing a list of participant JIDs or phone numbers along with the group ID.
Properties
| Name | Meaning |
|---|---|
| Session | The WhatsApp session to use for the operation, selected from existing sessions or entered manually. |
| Group ID | The unique identifier of the WhatsApp group from which participants will be removed. It should be the group JID ending with @g.us or a raw group ID. |
| Participants | A collection of participants to remove from the group. Each participant is identified by their JID or phone number. |
Output
JSON
json- The response from the WARest API after removing participants, typically containing the result of the removal operation.
Dependencies
- Requires an API key credential for the WARest WhatsApp REST API and the base URL of the API server.
Troubleshooting
- Ensure the session ID is valid and active; otherwise, the API call will fail.
- Verify that the group ID is correct and that the bot or session has permission to manage the group.
- Make sure the participants' JIDs or phone numbers are correctly formatted and exist in the group.
- Common error messages may include authorization errors if the API key or session is invalid, or not found errors if the group or participants do not exist.