Green API icon

Green API

Send WhatsApp messages via Green API or trigger workflows on webhooks
Join our community

Actions21

Overview

This node enables interaction with WhatsApp via the Green API service, specifically allowing management of group participants among other WhatsApp actions. The "Remove Group Participant" operation lets you remove a specified participant from a WhatsApp group by providing the group ID and the participant's chat ID.

Common scenarios for this node include automating group management tasks such as moderating group membership, removing inactive or unwanted participants, or integrating group participant management into broader workflows.

Practical example: Automatically remove a user from a WhatsApp group when they unsubscribe from a service or violate group rules, triggered by an external event in your workflow.

Properties

Name Meaning
Mode Select between "Action" (execute WhatsApp actions) or "Listen for Incoming Webhook" (trigger workflows on incoming webhooks). For this operation, use "Action".
Resource The type of WhatsApp entity to operate on; here it is "Group".
Operation The specific action to perform on the resource; here it is "Remove Group Participant".
Group ID The unique identifier of the WhatsApp group where the participant will be removed.
Participant Chat ID The chat ID of the participant to remove from the group (e.g., phone number with suffix).

Additional properties exist for other operations or modes but are not relevant for this operation.

Output

The node outputs a JSON array containing the response from the Green API after attempting to remove the participant. This typically includes status information about the removal request, such as success confirmation or error details.

No binary data output is involved in this operation.

Example output structure (simplified):

[
  {
    "json": {
      "result": "success",
      "message": "Participant removed successfully"
    }
  }
]

Dependencies

  • Requires an active Green API account with valid credentials: an instance ID and an API token.
  • The node makes HTTP POST requests to the Green API endpoints corresponding to WhatsApp group management.
  • Proper configuration of these credentials in n8n is necessary for authentication.
  • No additional external dependencies beyond standard Node.js modules and n8n helpers.

Troubleshooting

  • Common issues:

    • Invalid or missing Group ID or Participant Chat ID parameters will cause the operation to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity problems can prevent successful API calls.
    • Attempting to remove a participant who is not in the group may return an error from the API.

  • Error messages:

    • "Failed to remove group participant: <error message>" indicates the API call failed; check the provided IDs and credentials.
    • Errors related to reading files or binary data do not apply to this operation but may appear if other operations are used incorrectly.
    • "This node is configured as a trigger. Please use it as a trigger node, not an action node." means the node mode is set incorrectly for this operation; ensure "Mode" is set to "Action".

  • Resolution tips:

    • Verify that the Group ID and Participant Chat ID are correctly formatted and correspond to actual WhatsApp entities.
    • Confirm that the API credentials are valid and have sufficient permissions.
    • Check network access and firewall settings.
    • Use the node in "Action" mode for this operation, not "Trigger" mode.

Links and References

Discussion