Wappfy icon

Wappfy

Interact with WhatsApp through Wappfy API

Actions76

Overview

The "Pin Message" operation in the Chat resource allows users to pin a specific message within a WhatsApp chat using the Wappfy API. Pinning a message highlights it or keeps it easily accessible in the chat interface, which is useful for emphasizing important information or announcements.

Typical use cases include:

  • Highlighting key messages in group chats.
  • Keeping reminders or instructions visible at the top of a chat.
  • Marking important messages for quick reference.

For example, a team lead might pin a project deadline message in a group chat so all members can easily find it.

Properties

Name Meaning
Chat ID The unique identifier of the chat where the message to be pinned exists (e.g., 123456789@g.us for groups).
Message ID The unique identifier of the message that you want to pin within the specified chat.

Output

The node outputs the JSON response returned by the Wappfy API after attempting to pin the message. This typically includes confirmation details about the pinned message or any relevant status information.

The output structure is:

{
  "json": {
    // API response data confirming the pin action or error details
  }
}

No binary data is involved in this operation.

Dependencies

  • Requires an active Wappfy API credential with a valid API key and instance name configured in n8n.
  • The node makes HTTP requests to the Wappfy API endpoints.
  • Proper permissions on the WhatsApp account/session are necessary to pin messages.

Troubleshooting

  • Invalid Chat ID or Message ID: If the provided IDs are incorrect or do not exist, the API will return an error. Verify the IDs before running the node.
  • Permission Denied: Pinning messages may require admin privileges in group chats. Ensure the authenticated session has sufficient rights.
  • API Key Issues: Missing or invalid API keys will cause authentication failures. Confirm the API key is correctly set in credentials.
  • Network Errors: Connectivity issues to the Wappfy API endpoint will result in request failures. Check network access and API availability.
  • Error Messages: The node returns error messages from the API in the output JSON under an error field if continueOnFail is enabled. Review these messages for troubleshooting.

Links and References

Discussion