Evolution API icon

Evolution API

Interact with Evolution API

Actions114

Chat → Manage Archive

AI-generated

Overview

This node operation manages the archive status of a chat conversation in the Evolution API. It allows users to archive or unarchive a conversation by specifying the instance name, contact number, message ID, and whether the message was sent by the instance. This is useful for organizing and managing chat histories programmatically, such as archiving old conversations or restoring archived ones.

Use Case Examples

  1. Archiving a conversation with a specific contact to keep the chat list clean.
  2. Unarchiving a conversation to review previous messages.

Properties

Name Meaning
Instance Name The name of the instance to identify which Evolution API instance to use for the operation.
Contact The contact number of the chat conversation to be archived or unarchived.
Action Determines whether to archive (true) or unarchive (false) the conversation.
Message ID The ID of the last message in the conversation, used to identify the specific message context.
Message Is Mine Boolean flag indicating if the last message was sent by the instance, affecting how the archive action is applied.

Output

JSON

  • status - The status of the archive operation, indicating success or failure.
  • message - Additional information or confirmation message about the archive action performed.

Dependencies

  • Requires an API key credential for Evolution API authentication.

Troubleshooting

  • Ensure the instance name and contact number are correctly specified to avoid errors related to invalid or missing identifiers.
  • Verify that the message ID corresponds to an existing message in the conversation to prevent operation failure.
  • Check API authentication credentials if the node fails to connect or perform the archive action.

Links

  • Evolution API Documentation - Official documentation for the Evolution API, including details on chat management and archive operations.

Discussion