WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API
Join our community

Actions50

Overview

This node integrates with the WSAPI WhatsApp API, allowing users to interact programmatically with various WhatsApp resources. Specifically, for the Account resource and the Set Name operation, it enables updating the display name of a WhatsApp account. This is useful when you want to change how your WhatsApp account appears to your contacts without manually doing it in the app.

Practical examples:

  • Automatically update your business WhatsApp account name based on marketing campaigns or seasonal promotions.
  • Synchronize the WhatsApp display name with your CRM or user database.
  • Personalize the account name dynamically depending on workflow context.

Properties

Name Meaning
Name The new display name for your WhatsApp account. This is the name visible to your WhatsApp contacts. You enter the desired display name as a string (e.g., "My name").

Output

The node outputs JSON data representing the result of the set name operation. Typically, this will include confirmation details such as success status or updated account information. If the operation returns binary data (not typical for this operation), it would represent related media or files, but for setting the account name, output is purely JSON.

Dependencies

  • Requires an API key credential for authenticating with the WSAPI WhatsApp API.
  • The node expects the base URL of the WSAPI endpoint configured in the credentials.
  • No additional external dependencies are required beyond the WSAPI service.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an empty or invalid name string may result in API errors.
    • Network connectivity problems can prevent communication with the WSAPI endpoint.

  • Error messages:

    • "The resource "account" is not known!" — indicates a misconfiguration or unsupported resource selection.
    • "The operation "setName" is not implemented yet!" — suggests the operation is not recognized; verify correct spelling and availability.
    • API error messages returned from WSAPI typically indicate validation issues or permission problems; check that the API key has rights to modify account settings.

  • Resolution tips:

    • Ensure the API key credential is correctly set up and has necessary permissions.
    • Validate the input name property is non-empty and properly formatted.
    • Check network access and WSAPI service status.

Links and References

Discussion