WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API
Join our community

Actions50

Overview

This node interacts with the WSAPI WhatsApp API to manage WhatsApp groups. Specifically, the "Set Description" operation allows users to update the description text of a specified WhatsApp group. This is useful for keeping group members informed about the group's purpose or any important information.

Common scenarios:

  • Updating the description of a project team group to reflect current goals.
  • Setting a welcome message or guidelines in the group description for new members.
  • Changing the description dynamically based on workflow events or external triggers.

Example:
You have a WhatsApp group for daily standups. Using this node, you can automatically update the group description every morning with the agenda or key points for that day.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group. Format: group ID + @g.us (e.g., 120363123456789@g.us). This tells the node which group to update.
Description The new description text for the WhatsApp group. Visible to all group members. Use this to explain the group's purpose or provide relevant info.

Output

The node outputs JSON data representing the result of the "set description" operation. Typically, this will include confirmation that the description was updated successfully or details of the updated group.

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

Dependencies

  • Requires an active connection to the WSAPI WhatsApp API via an API key credential configured in n8n.
  • The base URL for the API must be set in the credentials.
  • No additional external dependencies are needed beyond the WSAPI service.

Troubleshooting

  • Invalid Group ID format: Ensure the Group ID includes the suffix @g.us. Missing or malformed IDs will cause errors.
  • Authentication errors: Verify that the API key credential is valid and has permissions to modify group settings.
  • Permission denied: The authenticated user must have admin rights in the WhatsApp group to change its description.
  • Network issues: Check connectivity to the WSAPI endpoint and confirm the base URL is correct.
  • Operation not implemented error: If the node throws an error about the operation not being implemented, ensure you selected the correct resource ("Group") and operation ("Set Description").

Links and References

Discussion