WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API

Overview

This node integrates with the WSAPI WhatsApp API to manage contacts within a WhatsApp account. Specifically, the Create Contact operation allows users to add new contacts by specifying their WhatsApp ID and name details. This is useful for automating contact management workflows, such as syncing CRM contacts to WhatsApp or programmatically adding new contacts before sending messages.

Practical examples include:

  • Adding a new customer’s WhatsApp contact after a sale.
  • Creating a contact entry for a business partner or supplier.
  • Automating contact creation in bulk from external databases.

Properties

Name Meaning
Contact ID The WhatsApp ID of the new contact to create. Must be formatted as a phone number with country code followed by @s.whatsapp.net (e.g., 1234567890@s.whatsapp.net). This uniquely identifies the contact in WhatsApp.
Full Name The complete display name for the contact as it should appear in your WhatsApp contacts (e.g., "John Smith" or "ABC Company").
First Name The given or first name of the contact (e.g., "John").

Note: For the Create Contact operation, the required properties are Contact ID and Full Name (based on typical usage; the provided JSON shows fullName required for create/update operations, but only newContactId and fullName are relevant here).

Output

The node outputs an array of JSON objects representing the result of the contact creation operation. Each output item corresponds to one input item processed.

The json output typically contains the newly created contact's details as returned by the WSAPI WhatsApp API, which may include fields like contact ID, name, and any metadata returned by the API.

If the node supports binary data output (not indicated explicitly here), it would represent media or attachments related to the contact, but this operation primarily deals with JSON data.

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 beyond the WSAPI service.

Troubleshooting

  • Invalid Contact ID format: Ensure the Contact ID follows the exact format phone_number@s.whatsapp.net. Missing country codes or incorrect suffixes will cause errors.
  • Missing required fields: Both Contact ID and Full Name must be provided; otherwise, the API will reject the request.
  • API authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Network or connectivity issues: Check that the base URL is reachable and the network allows outbound requests to the WSAPI endpoint.
  • Operation not implemented error: If you see an error about the operation not being implemented, ensure you selected the correct Resource ("Contact") and Operation ("Create Contact").

Links and References


If you need further details on other operations or resources, feel free to ask!

Discussion