WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API

Overview

The node integrates with the WSAPI WhatsApp API to perform various operations related to WhatsApp contacts, including updating a contact's full name. Specifically, the "Update Full Name" operation for the Contact resource allows users to modify the display name of a WhatsApp contact identified by their unique contact ID (phone number with country code and domain).

This node is beneficial in scenarios where you need to keep your WhatsApp contact list up-to-date programmatically, such as syncing contact names from a CRM system or updating contact information based on external data sources.

Practical example:
You have a customer database with updated full names, and you want to reflect these changes in your WhatsApp contacts automatically. Using this node, you can input the contact ID and the new full name to update the contact's display name in WhatsApp.

Properties

Name Meaning
Contact ID The WhatsApp contact identifier formatted as phone number with country code plus @s.whatsapp.net. Example: 1234567890@s.whatsapp.net. This uniquely identifies the contact to update.
Full Name The complete display name for the contact as it should appear in your WhatsApp contacts. Examples: "John Smith" or "ABC Company".

Output

The node outputs JSON data representing the result of the update operation. Typically, this will include confirmation details about the updated contact or any relevant metadata returned by the WSAPI WhatsApp API.

If the operation involves binary data (not applicable here), the node would output binary content accordingly, but for updating a contact's full name, only JSON output is expected.

Dependencies

  • Requires an active connection to the WSAPI WhatsApp API.
  • Needs an API key credential configured in n8n to authenticate requests to the WSAPI endpoint.
  • The base URL for the WSAPI must be set in the credentials configuration.

Troubleshooting

  • Invalid Contact ID format: Ensure the contact ID follows the required format: phone number with country code followed by @s.whatsapp.net. For example, 1234567890@s.whatsapp.net.
  • Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Operation not implemented error: If the node throws an error indicating the operation is not implemented, confirm that the selected resource is "Contact" and the operation is "Update Full Name".
  • Network issues: Check connectivity to the WSAPI endpoint and ensure the base URL is correct.
  • Empty or missing Full Name: The full name field is required; ensure it is provided and not empty.

Links and References

Discussion