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 specific message within a chat session on WhatsApp using the WARest WhatsApp REST API. It is useful for highlighting important messages in a chat for easy access or reference. For example, a user can pin a key announcement message in a group chat or unpin a message that is no longer relevant.
Use Case Examples
- Pin a message in a group chat to keep it visible to all participants.
- Unpin a previously pinned message to remove it from the pinned section of the chat.
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 where the message resides, e.g., a phone number with domain or group ID. |
| Message ID | The unique identifier of the message within the chat to be pinned or unpinned. |
| Pin? | Boolean flag to specify whether to pin (true) or unpin (false) the message. |
Output
JSON
json- The API response containing the result of the pin or unpin action on the message.
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 that the chat ID and message ID are correct and correspond to existing entities in the WhatsApp session.
- Check that the API key credential is correctly configured and has the necessary permissions to perform pin/unpin actions.
- Common error messages include 'Operation not implemented' if the operation name is incorrect, or API errors indicating invalid parameters or session issues.
Links
- WARest API Documentation - Pin/Unpin Message - Official API documentation for the pin/unpin message endpoint used by this node operation.