WAREST icon

WAREST

Interact with the WARest WhatsApp REST API

Overview

This node operation clears all messages in a specified chat within a WhatsApp session using the WARest WhatsApp REST API. It is useful for scenarios where you want to programmatically delete all chat history for a particular chat, such as for privacy reasons, chat management, or resetting a conversation.

Use Case Examples

  1. Clear all messages in a chat with a specific contact or group within a selected WhatsApp session.
  2. Automate chat cleanup processes by clearing chat messages based on workflow triggers.

Properties

Name Meaning
Session The WhatsApp session identifier from which the chat messages will be cleared. This can be selected from a list of available sessions or entered manually.
Recipient / Chat (to) The phone number or JID of the chat whose messages are to be cleared. This identifies the target chat for the clear operation.

Output

JSON

  • json - The response from the WARest API after clearing the chat messages, typically confirming the success or failure of the operation.

Dependencies

  • Requires an API key credential for the WARest WhatsApp REST API and the base URL of the API server.

Troubleshooting

  • Ensure the session ID is valid and active; otherwise, the API call will fail.
  • The 'to' field must be a valid phone number or JID corresponding to an existing chat; invalid identifiers will cause errors.
  • API connectivity issues or incorrect API credentials will prevent the operation from succeeding.

Links

Discussion