WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API

Actions50

Overview

This node interacts with the WSAPI WhatsApp API to perform various messaging-related actions. Specifically, the "Mark as Read" operation under the "Message" resource marks a specified WhatsApp message thread (contact or group) as read. This is useful in automation workflows where you want to programmatically acknowledge messages without manual intervention.

Common scenarios:

  • Automatically marking incoming messages as read after processing them.
  • Keeping message threads updated in WhatsApp to reflect that messages have been seen.
  • Integrating WhatsApp message status updates into broader customer support or CRM workflows.

Practical example:
You receive new messages via WhatsApp and process them in n8n. After processing, you use this node's "Mark as Read" operation to mark those messages as read on WhatsApp, ensuring your chat interface stays synchronized with your workflow.

Properties

Name Meaning
To The WhatsApp contact ID or group ID to mark as read. For contacts, this is the phone number followed by @s.whatsapp.net (e.g., 1234567890@s.whatsapp.net). For groups, it is the group ID followed by @g.us (e.g., 120363123456789@g.us). The phone number must include the country code but without the plus sign.

Output

The node outputs JSON data representing the result of the "Mark as Read" operation. Typically, this will confirm whether the action was successful or provide error details if it failed.

No binary data output is expected from this operation.

Dependencies

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

Troubleshooting

  • Common issues:

    • Incorrectly formatted "To" property (missing country code, wrong suffix like @s.whatsapp.net or @g.us) can cause failures.
    • Invalid or expired API authentication token will prevent the request from succeeding.
    • Network connectivity issues to the WSAPI endpoint.

  • Error messages:

    • "The resource "message" is not known!" — indicates a misconfiguration of the resource parameter.
    • "The operation "markAsRead" is not implemented yet!" — suggests the operation name might be misspelled or unsupported.
    • API errors returned from WSAPI will typically include descriptive messages; ensure the "To" field is valid and the API key is correct.

  • Resolution tips:

    • Double-check the format of the WhatsApp ID used in the "To" field.
    • Verify the API key and base URL in the node credentials.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully during batch executions.

Links and References

Discussion