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, the "Set Name" operation for the "Group" resource allows users to update 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 to match a new project phase.
  • Updating a social group’s name to reflect a new event or theme.
  • Correcting typos or standardizing naming conventions across multiple groups.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group to rename. Format: group ID + @g.us (e.g., 120363123456789@g.us). Required to specify which group to update.
Group Name The new name to assign to the WhatsApp group. This name will be visible to all group members.

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.

No binary data output is expected from this operation.

Dependencies

  • Requires an active connection to the WSAPI WhatsApp API.
  • An API key credential (or equivalent authentication token) must be configured in n8n to authorize requests.
  • The base URL for the WSAPI endpoint must be set in the credentials.

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:

    • "The resource "groups" is not known!": Indicates the resource parameter was incorrect or unsupported.
    • "The operation "setName" is not implemented yet!": Suggests the operation is not available; verify node version and configuration.
    • API errors returned from WSAPI typically include descriptive messages; ensure the Group ID and Group Name are valid and properly formatted.

  • Resolutions:

    • Double-check the Group ID format and existence.
    • Verify API credentials and permissions.
    • Ensure network access to the WSAPI service.
    • Update the node or WSAPI integration if operations are missing.

Links and References

Discussion