WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API

Overview

This node integrates with the WSAPI WhatsApp API to perform various operations on WhatsApp resources. Specifically, for the Contact resource and the Update Contact operation, it allows updating details of an existing WhatsApp contact by specifying its unique identifier and new information such as full name or first name.

Common scenarios where this node is beneficial include:

  • Keeping your WhatsApp contact list up-to-date automatically from a CRM or database.
  • Correcting or enriching contact information in bulk.
  • Synchronizing contact names between different systems and WhatsApp.

For example, you could use this node to update the display name of a contact after a customer changes their name or to add missing first names to contacts imported without them.

Properties

Name Meaning
Contact ID The unique WhatsApp identifier for the contact, formatted as phone number plus @s.whatsapp.net. Example: 1234567890@s.whatsapp.net. This identifies which contact to update.
Full Name The complete display name for the contact as it should appear in WhatsApp (e.g., "John Smith" or "ABC Company").
First Name The given or first name of the contact (e.g., "John").

Output

The node outputs JSON data representing the result of the update operation. This typically includes confirmation of the updated contact details or status information returned by the WSAPI WhatsApp API.

If the operation returns binary data (not typical for contact updates), it would represent associated media or files related to the contact, but this is not expected here.

Dependencies

  • Requires an active connection to the WSAPI WhatsApp API via an API key credential configured in n8n.
  • The base URL for the API is taken from the credential configuration.
  • No additional external dependencies are required beyond the WSAPI service.

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.
  • Missing required fields: Both Contact ID and at least one field to update (Full Name or First Name) must be provided.
  • API authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Operation not implemented error: If you see an error about the operation not being implemented, confirm that the node version supports the Update Contact operation.
  • Network or connectivity issues: Check your network connection and the availability of the WSAPI WhatsApp API endpoint.

Links and References

Discussion