WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API
Join our community

Actions50

Overview

This node integrates with the WSAPI WhatsApp API to manage WhatsApp groups, specifically allowing you to update group participants. It is useful in scenarios where you need to programmatically add or remove members from a WhatsApp group, such as managing community groups, customer support groups, or team communication channels.

For example, you can use this node to:

  • Add new users to a WhatsApp group after they register on your platform.
  • Remove inactive or unauthorized participants automatically.
  • Synchronize group membership based on external user databases.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group to update. Format: group ID followed by @g.us (e.g., 120363123456789@g.us). This specifies which group’s participants will be updated.
Participants A collection containing participant phone numbers to update in the group. Enter phone numbers as a comma-separated string including country codes (e.g., 1234567890,0987654321,1122334455).

Output

The node outputs JSON data representing the result of the update participants operation. This typically includes confirmation of the update or details about the modified group participants.

If the operation involves binary data (not indicated here), it would represent media or files related to the group, but for updating participants, the output is purely JSON.

Dependencies

  • Requires an active connection to the WSAPI WhatsApp API service.
  • Needs an API key credential configured in n8n to authenticate requests.
  • The base URL for the API is taken from the credential configuration.

Troubleshooting

  • Invalid Group ID format: Ensure the Group ID follows the required format (groupID@g.us). Incorrect formatting will cause errors.
  • Incorrect phone number format: Phone numbers must include country codes and be comma-separated without spaces.
  • Authentication errors: Verify that the API key credential is correctly set up and has permissions to modify group participants.
  • API limits or restrictions: The WhatsApp API may limit how frequently participants can be updated; check API documentation if updates fail repeatedly.
  • Network issues: Ensure the n8n instance can reach the WSAPI endpoint specified in the credentials.

Common error messages might include:

  • "The resource "groups" is not known!" — indicates a misconfiguration of the resource parameter.
  • "The operation "updateParticipants" is not implemented yet!" — suggests the operation name is incorrect or unsupported.
  • API response errors indicating invalid input or permission denied, which require checking inputs and credentials.

Links and References

Discussion