ZAPIN icon

ZAPIN

Interact with Zapin EVO

Actions64

Chat → Manage Archive

AI-generated

Overview

This node operation manages the archive status of a chat conversation in a chat API instance. 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 chat conversations, keeping the chat interface clean, or restoring archived conversations when needed.

Use Case Examples

  1. Archiving a conversation with a specific contact to keep the chat list organized.
  2. Unarchiving a conversation to resume communication or review past messages.

Properties

Name Meaning
Instance Name The name of the chat API instance to target for the archive operation.
Contact The contact number of the chat conversation to be archived or unarchived.
Action Specifies whether to archive (true) or unarchive (false) the conversation.
Message ID The ID of the last message in the conversation, used to identify the conversation state.
Message Is From Me Indicates if the last message was sent by the instance, which may affect how the archive action is processed.

Output

JSON

  • status - The result status of the archive or unarchive operation.
  • message - A message providing additional information about the operation result.

Dependencies

  • Requires an API key credential for authentication with the chat API instance.

Troubleshooting

  • Ensure the instance name and contact number are correctly specified to avoid errors related to invalid targets.
  • Verify that the message ID corresponds to a valid message in the conversation to prevent operation failures.
  • Check API authentication credentials if the node fails to connect or perform the operation.
  • Common error messages may include unsupported operation errors if the resource or operation parameters are incorrect, or API errors if the chat service is unreachable or returns an error response.

Discussion