WaAPI icon

WaAPI

Interact with WaAPI API

Actions83

Overview

This node operation allows you to remove a participant from a WhatsApp group chat. It is useful in scenarios where you need to manage group membership dynamically, such as moderating group participants, automating removal of inactive members, or enforcing group policies programmatically.

For example, if you run a community group and want to automatically remove users who violate rules or no longer belong to the group, this node can be integrated into your workflow to perform that action seamlessly.

Properties

Name Meaning
Id Instance ID (a required numeric identifier for the specific instance or context)
Chat Id The unique identifier of the WhatsApp group chat from which the participant will be removed. Format example: <yyyyyyyyyyyyyyy>@g.us
Participant The unique identifier of the participant to remove from the group. Format example: <xxxxxxxxx>@c.us

Output

The node outputs JSON data representing the result of the remove participant operation. This typically includes confirmation of success or failure and any relevant metadata returned by the API. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the WaAPI service.
  • Depends on the external WaAPI REST API endpoint at https://waapi.app/api/v1.
  • The node uses HTTP requests with JSON payloads to interact with the API.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Incorrectly formatted chatId or participant identifiers may lead to errors or no action taken.
    • Attempting to remove a participant who is not part of the group might return an error or no effect.
  • Error messages:
    • Authentication errors: Verify that the API key credential is correctly configured.
    • Validation errors: Ensure chatId and participant are in the correct format (<id>@g.us for groups, <id>@c.us for contacts).
    • Network or API errors: Check connectivity and API service status.

Links and References

  • WaAPI Documentation (for detailed API usage and parameters)
  • WhatsApp Group IDs format reference: Typically ends with @g.us
  • WhatsApp Contact IDs format reference: Typically ends with @c.us

Discussion