WAHA API icon

WAHA API

Complete WhatsApp automation with WAHA API - Multi-engine support
Join our community

Actions55

Overview

The "Unpin Chat" operation in the WAHA API node allows users to unpin a previously pinned chat in WhatsApp. This is useful for managing chat priorities and organization within WhatsApp sessions, especially when you want to remove the pin status from a chat that was previously marked as important or easily accessible.

Practical scenarios include:

  • Automatically unpinning chats after a certain event or time period.
  • Managing chat pins dynamically based on workflow logic.
  • Cleaning up pinned chats in bulk or selectively via automation.

Properties

Name Meaning
Session Name The name of the WhatsApp session to use. Defaults to the configured default session.
Chat ID The unique identifier of the WhatsApp chat to unpin. It can be a phone number with @c.us or a group ID with @g.us.
Additional Fields Optional extra parameters (not specifically used for unpin but available for other operations).

Output

The node outputs a JSON object representing the response from the WAHA API after attempting to unpin the specified chat. The structure typically includes confirmation of success or details about the unpin action. If an error occurs, the output will contain an error message describing the issue.

No binary data is involved in this operation.

Example output JSON might look like:

{
  "success": true,
  "message": "Chat unpinned successfully",
  "chatId": "5511999999999@c.us"
}

Dependencies

  • Requires a valid WAHA API credential with an API key and base URL configured in n8n.
  • Optionally uses an additional API key credential for subscription validation via the N8N Tools API.
  • The node sends HTTP requests to the WAHA API endpoints to perform chat management actions.
  • The user must have an active WhatsApp session identified by the session name.

Troubleshooting

  • Invalid Credentials: If the API key or subscription is invalid, the node will throw an error indicating invalid subscription or API key. Verify credentials in n8n settings.
  • Unknown Resource or Operation: Errors occur if the resource or operation names are incorrect or unsupported. Ensure "Chat" resource and "Unpin Chat" operation are selected.
  • Chat ID Issues: Providing an incorrect or malformed chat ID will cause the API call to fail. Use the correct format (phone@c.us or groupid@g.us).
  • Session Not Found: If the specified session name does not exist or is inactive, the operation will fail. Confirm the session is active and correctly named.
  • API Request Failures: Network issues or API downtime may cause request failures. Check connectivity and WAHA API status.

Links and References

Discussion