WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API

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.

Practical examples include:

  • Updating project group descriptions to reflect current goals.
  • Setting event-specific details in event planning groups.
  • Adding guidelines or rules visible to all group members.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group, formatted as group ID + @g.us (e.g., 120363123456789@g.us). This specifies which group’s description will be updated.
Description The new description text for the WhatsApp group. This text explains the group's purpose and is visible to all members. Example: "This group is for project discussions and updates."

Output

The node outputs JSON data representing the result of the set description operation. Typically, this includes confirmation that the description was successfully updated or error information if the operation failed.

No binary data output is involved in this operation.

Dependencies

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

Troubleshooting

  • Invalid Group ID Format: Ensure the Group ID follows the format number@g.us. An incorrect format will cause the API to reject the request.
  • Permission Errors: The API key used must have permissions to modify group details. Lack of proper authorization will result in errors.
  • Empty Description: Providing an empty description string may cause the API to reject the update or clear the description unintentionally.
  • Network Issues: Connectivity problems with the WSAPI endpoint can cause timeouts or failures.
  • Error Messages: If the node throws errors like "The operation 'setDescription' is not implemented yet!" it indicates a misconfiguration or unsupported operation in the current version.

To resolve these issues:

  • Double-check the Group ID format.
  • Verify API key permissions.
  • Provide meaningful description text.
  • Ensure stable network connectivity.
  • Update the node or WSAPI integration if operations are missing.

Links and References

Discussion