Actions90
- Sessions Actions
- Messages - Sending Actions
- Chats Actions
- Messages - Actions Actions
- Groups Actions
- List Groups
- Group Info
- Get Invite Link
- Revoke Invite Link
- Join via Link
- Preview via Link
- Create Group
- Delete Group
- Update Group Description
- Toggle Announcement Mode
- List Participants
- Add Participants
- Remove Participants
- Demote Participants
- Approve Join Request
- Reject Join Request
- List Join Requests
- Get Group Picture
- Set Group Picture
- Delete Group Picture
- Leave Group
- Update Group Name
- Lock Group Edits
- Promote Participants
- Profile Actions
- Server Actions
- Miscellaneous Actions
Overview
This node operation archives a chat in a specified WhatsApp session using the WARest WhatsApp REST API. It is useful for automating chat management tasks such as organizing or cleaning up chat lists by moving chats to the archive. For example, a user can archive chats that are no longer active but need to be retained for record-keeping.
Use Case Examples
- Archiving a chat with a specific contact or group in a WhatsApp session to keep the chat list organized.
- Automatically archiving chats after a certain period of inactivity to maintain a clean interface.
Properties
| Name | Meaning |
|---|---|
| Session | The WhatsApp session identifier from which the chat will be archived. This can be selected from a list of available sessions or entered manually. |
| Recipient / Chat (to) | The phone number or JID of the chat to archive. This identifies the specific chat to be archived within the selected session. |
Output
JSON
json- The response from the WARest API after attempting to archive the chat, typically containing the result or status of the archive 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.
- Verify the 'to' field contains a valid phone number or JID corresponding to an existing chat in the session.
- Common error messages may include 'Operation not implemented' if the operation name is incorrect, or API errors related to authentication or invalid parameters. Check credentials and input values accordingly.
Links
- WARest WhatsApp REST API - Official repository and documentation for the WARest WhatsApp REST API used by this node.