Actions70
- Chat Actions
- Community Actions
- Group Actions
- Instance Actions
- Label Actions
- Message Actions
- Newsletter Actions
- Send Message Actions
- User Actions
Chat → Archive Chat
AI-generatedSummary
Archives a specific WhatsApp chat in the connected instance.
Inputs
- instanceApiKey (required) — Instance API key for authentication.
- chatChat (required) — The chat JID (e.g., 5511999999999@s.whatsapp.net).
- requestOptions — Optional HTTP request settings including batching, timeout, proxy, and SSL verification.
Output shape
a single item (success envelope) if the archive operation succeeds
The operation returns a success envelope; it does not return the chat data or history.
Examples
Example 1: Archive a chat for a specific number after receiving a user message
Use the chat JID of the recipient and your instance API key.