WAREST icon

WAREST

Interact with the WARest WhatsApp REST API

Overview

This node operation unarchives a chat in a WhatsApp session using the WARest WhatsApp REST API. It is useful for restoring chats that were previously archived, making them active and visible again in the chat list. For example, a user can automate unarchiving a chat when a new message arrives or based on specific workflow triggers.

Use Case Examples

  1. Automatically unarchive a chat when a customer sends a new message to ensure the chat is visible for immediate response.
  2. Restore archived chats in bulk based on a schedule or event to keep the chat list updated.

Properties

Name Meaning
Session The WhatsApp session identifier to use for the operation. It can be selected from a list of active sessions or entered manually.
Recipient / Chat (to) The phone number or JID of the chat to unarchive. This identifies which chat will be restored from the archive.

Output

JSON

  • json - The response from the WARest API after unarchiving the chat, typically containing the status or details of the unarchived chat.

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 archived chat; invalid values will cause errors.
  • Check API credentials and network connectivity if requests fail.
  • If the operation is not implemented or the API endpoint changes, the node will throw an error indicating the operation is not supported.

Links

Discussion