Evolution API icon

Evolution API

Complete WhatsApp automation with Evolution API
Join our community

Actions48

Overview

This node integrates with the Evolution API to manage WhatsApp groups and other WhatsApp-related resources. Specifically, the Remove Participant operation under the Group resource allows users to remove one or more participants from a specified WhatsApp group.

Common scenarios where this node is beneficial include:

  • Automating group management tasks such as moderating group membership.
  • Removing inactive or unwanted members from WhatsApp groups automatically.
  • Integrating WhatsApp group management into broader workflows for customer support, community management, or team coordination.

For example, you could set up an automation that removes participants who have violated group rules or left the organization, keeping your WhatsApp groups clean and relevant.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group from which participants will be removed.
Additional Fields Optional parameters including:
• Delay (milliseconds before sending)
• Link Preview (enable/disable link previews)
• Quoted Message ID (ID of message to quote/reply to)
• Mentions (comma-separated list of numbers to mention)

Note: For the Remove Participant operation, the main required property is the Group ID. The participants to remove are expected to be provided in the "Participants" field (not shown in the provided properties snippet but used internally).

Output

The node outputs JSON data representing the response from the Evolution API after attempting to remove the participant(s) from the group. This typically includes confirmation of the action or error details if the removal failed.

The output structure is:

{
  "json": {
    // API response object confirming removal or containing error info
  },
  "pairedItem": {
    "item": <index_of_input_item>
  }
}

No binary data is output by this operation.

Dependencies

  • Requires an active connection to the Evolution API service.
  • Needs valid credentials including:
    • An API key credential for authenticating requests to the Evolution API.
    • Optionally, an additional API key credential for a secondary validation service ("N8N Tools API").
  • The node expects configuration of instance name and base URL for the Evolution API.
  • Proper permissions on the WhatsApp group to remove participants.

Troubleshooting

  • Invalid Credentials Error: If the API keys are incorrect or expired, the node will throw authentication errors. Verify and update your API keys in n8n credentials.
  • Permission Denied: Attempting to remove participants without admin rights in the WhatsApp group will fail. Ensure the authenticated user has sufficient privileges.
  • Group Not Found: Providing an incorrect or malformed Group ID will result in errors. Double-check the Group ID value.
  • Participant Not in Group: Trying to remove a participant who is not part of the group may cause an error or no effect.
  • API Rate Limits: Excessive calls might trigger rate limiting; consider adding delays using the "Delay" additional field.

If the node encounters an error and "Continue On Fail" is disabled, it will stop execution and throw the error. Enabling "Continue On Fail" allows the workflow to proceed while returning error details in the output.

Links and References

Discussion