Actions69
- App Actions
- Chat Actions
- Device Actions
- Group Actions
- Add Participant
- Approve Participant Request
- Create Group
- Demote Participant
- Export Group Participants
- Get Group Info
- Get Group Info From Link
- Get Group Invite Link
- Get Group Participants
- Get Participant Requests
- Join Group With Link
- Leave Group
- Promote Participant
- Reject Participant Request
- Remove Participant
- Set Group Announce Mode
- Set Group Locked Status
- Set Group Name
- Set Group Photo
- Set Group Topic
- Message Actions
- Newsletter Actions
- Send Actions
- User Actions
Chat → Pin Chat
AI-generatedOverview
This node operation allows users to pin or unpin a chat in the Go WhatsApp Web MultiDevice API. It is useful for managing chat visibility and prioritization by marking important chats as pinned or removing the pin to deprioritize them. For example, a user can pin a frequently accessed group chat or unpin a chat that is no longer a priority.
Use Case Examples
- Pin a group chat to keep it at the top of the chat list.
- Unpin a chat to remove it from the pinned section.
Properties
| Name | Meaning |
|---|---|
| Device ID | Optional device ID override that takes priority over the credential device ID if set. |
| Chat JID | The unique identifier of the chat to pin or unpin, e.g., phone@s.whatsapp.net for individual chats or groupid@g.us for group chats. |
| Pinned | Boolean flag indicating whether to pin (true) or unpin (false) the chat. |
Output
JSON
json- The response from the API indicating the result of the pin or unpin operation on the chat.
Dependencies
- Requires an API key credential for the Go WhatsApp Web MultiDevice API with host URL configuration.
Troubleshooting
- Ensure the Chat JID is correctly formatted and corresponds to an existing chat.
- Verify that the device ID override, if used, is valid and authorized.
- Check API credentials and host URL configuration to avoid authentication errors.
- Common errors include invalid chat JID, unauthorized device ID, or network issues. Verify inputs and credentials to resolve these.