WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API

Overview

This node integrates with the WSAPI WhatsApp API to manage WhatsApp groups. Specifically, the "Set Name" operation for the "Group" resource allows users to change the name of an existing WhatsApp group. This is useful in scenarios where a group’s purpose or membership changes and the group name needs to be updated to reflect that.

Practical examples include:

  • Renaming a project team chat group after project phases.
  • Updating event group names to match new event titles.
  • Correcting typos or standardizing naming conventions across multiple groups.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group, formatted as <groupID>@g.us (e.g., 120363123456789@g.us). This identifies which group’s name will be changed.
Group Name The new name to assign to the WhatsApp group. This name will be visible to all group members. Example: "Project Team Chat".

Output

The node outputs JSON data representing the result of the rename operation. Typically, this includes confirmation details such as success status or updated group information. If the operation fails, the output may contain error messages describing the issue.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the WSAPI WhatsApp API service.
  • Needs an API authentication token configured in the node credentials to authorize requests.
  • The base URL for the WSAPI must be set in the credentials configuration.

Troubleshooting

  • Common Issues:

    • Invalid or incorrectly formatted Group ID (must end with @g.us).
    • Insufficient permissions or invalid API credentials causing authorization failures.
    • Network connectivity issues preventing communication with the WSAPI endpoint.
    • Attempting to rename a non-existent or deleted group.
  • Error Messages & Resolutions:

    • "The resource "groups" is not known!": Indicates a misconfiguration of the resource parameter; ensure "Group" is selected.
    • "The operation "setName" is not implemented yet!": Suggests the operation is not recognized; verify the operation name is correct.
    • API errors returned from WSAPI (e.g., unauthorized, not found) should be checked against the API documentation and credentials.

Links and References

Discussion