Zappfy API icon

Zappfy API

Interact with Zappfy API

Overview

This node integrates with the Zappfy API, enabling users to perform various operations on chat resources. Specifically, for the "Chat" resource and the "Mark as Unread" operation, it allows marking a particular message in a chat as unread. This can be useful in scenarios where you want to flag messages for follow-up or indicate that a message requires attention later.

Practical examples include:

  • Automatically marking incoming messages as unread if they meet certain criteria (e.g., contain specific keywords).
  • Managing message states programmatically to keep track of which messages need review.

Properties

Name Meaning
Nome Da Instância The name of the instance to connect to the Zappfy API.
Contato The contact number associated with the chat where the message is located.
ID Da Mensagem The unique identifier of the last message to mark as unread.
Mensagem É Minha Boolean indicating whether the message was sent by the instance itself (true) or not (false).

Output

The node outputs a JSON array containing the response from the Zappfy API after attempting to mark the specified message as unread. The exact structure depends on the API's response but typically includes confirmation of the action or details about the updated message state.

No binary data output is indicated.

Dependencies

  • Requires an active connection to the Zappfy API.
  • Needs an API authentication credential configured in n8n to authorize requests.
  • The base URL for API requests is https://docs.zappfy.io/api-reference.

Troubleshooting

  • Operation Not Supported Error: If the node throws an error stating the operation is not supported, verify that the "resource" and "operation" parameters are correctly set to "chat" and "mark-unread" respectively.
  • Authentication Issues: Ensure the API key or authentication token is valid and properly configured in n8n credentials.
  • Invalid Message ID or Contact Number: Errors may occur if the provided message ID or contact number does not exist or is incorrectly formatted. Double-check these inputs.
  • Network or API Availability: Connectivity issues or API downtime can cause failures; verify network access and API status.

Links and References

Discussion