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 allows users to pin or unpin a chat in WhatsApp using the WARest WhatsApp REST API. It is useful for managing chat visibility and prioritization by toggling the pinned status of a chat. For example, a user can pin important chats to keep them at the top of their chat list or unpin them when they are no longer a priority.
Use Case Examples
- Pin a chat to keep it at the top of the chat list for quick access.
- Unpin a chat to remove it from the pinned section and return it to the normal chat list order.
Properties
| Name | Meaning |
|---|---|
| Session | The WhatsApp session identifier to use for the operation, selected from existing sessions or entered manually. |
| Chat ID / JID | The unique identifier of the chat to pin or unpin, such as a phone number with domain or group ID. |
| Pin? | Boolean flag to enable pinning (true) or unpinning (false) the specified chat. |
Output
JSON
json- The response from the WARest API indicating the result of the pin/unpin chat 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 chat ID (JID) is correct and corresponds to an existing chat.
- Check that the API key credential is correctly configured and has the necessary permissions.
- If the operation is not implemented error occurs, confirm the resource is 'chats' and operation is 'pinChat'.
- Network or server errors may occur if the WARest API server is unreachable or down.