WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API

Actions50

Overview

This node integrates with the WSAPI WhatsApp API to retrieve detailed business profile information for a specific WhatsApp contact. It is particularly useful when you need to access metadata about a contact's business account, such as business description, address, or other profile details that are available via WhatsApp Business profiles.

Common scenarios include:

  • Enriching customer data in CRM systems by fetching up-to-date business profile info.
  • Automating workflows that depend on verifying or displaying business details of contacts.
  • Integrations where business profile data influences decision-making or routing logic.

Example: Given a WhatsApp contact ID (phone number with country code and suffix), the node fetches the associated business profile details, which can then be used downstream in automation or reporting.

Properties

Name Meaning
Contact ID WhatsApp contact identifier formatted as phone number + @s.whatsapp.net (e.g., 1234567890@s.whatsapp.net). This uniquely identifies the contact whose business profile will be retrieved.
Cache Results Boolean option to cache the result for repeated requests with the same Contact ID to improve performance and reduce API calls.
Cache TTL (sec) Time-to-live in seconds for the cached entry if caching is enabled. Defines how long the cached data remains valid before a fresh API call is made.

Output

The node outputs JSON data representing the business profile information of the specified WhatsApp contact. The structure typically includes fields such as business name, description, address, email, website, and other relevant business metadata provided by the WhatsApp Business profile.

If the node supports binary data output (not explicitly shown here), it would represent media or images related to the business profile, but this operation primarily returns structured JSON data.

Dependencies

  • Requires an active connection to the WSAPI WhatsApp API service.
  • Needs an API key credential configured in n8n to authenticate requests.
  • The base URL for the API is taken from the credentials configuration.
  • Optional caching mechanism controlled by input properties to optimize repeated requests.

Troubleshooting

  • Invalid Contact ID format: Ensure the Contact ID follows the required format (phoneNumber@s.whatsapp.net). Incorrect formatting will likely cause errors or empty responses.
  • API authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Cache-related issues: If enabling caching, stale data might be returned until the TTL expires. Adjust the TTL according to your freshness requirements.
  • Operation not implemented error: This indicates the selected operation is not supported; ensure "Get Business Profile" is chosen under the "Contact" resource.
  • Network or API downtime: Check connectivity and WSAPI service status if requests fail unexpectedly.

Links and References

Discussion