MegaAPI icon

MegaAPI

Interact with MegaAPI WhatsApp service

Actions29

Overview

This node operation removes one or more participants from an existing WhatsApp group. It is useful when you want to manage group membership by excluding certain members, for example, to moderate the group or remove inactive or unwanted participants.

Practical scenarios include:

  • Automatically removing users who violate group rules.
  • Cleaning up group membership after an event or campaign.
  • Managing group size limits by removing excess participants.

The operation requires that the user executing it is an admin of the WhatsApp group.

Properties

Name Meaning
Group JID The unique identifier of the WhatsApp group from which participants will be removed. Format: group_id@g.us (e.g., 120363041490582303@g.us).
Participants Comma-separated list of participant phone numbers to remove from the group. Each must be in the format 551188888888@s.whatsapp.net.
Information A notice indicating that this operation removes participants from a WhatsApp group and that the response includes status and details about removed members.

Output

The output JSON contains the result of the removal operation. It typically includes:

  • Operation status (success or failure).
  • Details about each participant removed, such as their identifiers and whether the removal was successful.

No binary data is produced by this operation.

Dependencies

  • Requires a valid connection to the MegaAPI WhatsApp service.
  • An API authentication token (API key credential) must be configured in the node credentials.
  • The WhatsApp instance must have admin privileges in the target group to perform participant removals.

Troubleshooting

  • Common issues:

    • Attempting to remove participants without being an admin of the group will fail.
    • Incorrectly formatted Group JID or participant IDs will cause errors.
    • Removing participants who are not currently in the group may result in partial failures.

  • Error messages:

    • "Unknown group operation: removeParticipants": Indicates the operation name is incorrect or unsupported; ensure "Remove Participants" is selected.
    • Errors related to authorization or permissions usually mean the API token is invalid or the user lacks admin rights.
    • Validation errors on participant formatting require checking the phone number format (number@s.whatsapp.net).

To resolve these, verify your admin status in the group, confirm correct input formats, and ensure your API credentials are valid.

Links and References

Discussion