Unipile icon

Unipile

Interact with Unipile API

Overview

The node interacts with the Unipile API, specifically allowing users to patch (update) chat information within the Messaging resource. The "Patch Chat" operation is designed to modify certain attributes of a chat, such as setting its read status.

This node is useful in scenarios where you want to programmatically update chat metadata, for example:

  • Marking a chat as read or unread after processing messages.
  • Changing chat states or flags based on external triggers or workflows.

Practical example: After receiving and processing messages from a chat, you can use this node to mark the chat as read automatically, ensuring your system keeps track of which chats have been handled.

Properties

Name Meaning
Chat ID The unique identifier of the chat to be patched.
Action The type of update action to perform on the chat. For this operation, the option is: setReadStatus.
Value The value associated with the action. For setReadStatus, typically "true" or "false" indicating whether the chat should be marked as read or unread.

Output

The node outputs JSON data representing the response from the Unipile API after performing the patch operation on the chat. This typically includes updated chat details or confirmation of the applied changes.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Unipile API.
  • The base URL for API requests is configured via credentials.
  • The node sends HTTP PATCH requests with JSON bodies containing the action and value parameters.

Troubleshooting

  • Missing or invalid Chat ID: Ensure the Chat ID provided is correct and corresponds to an existing chat; otherwise, the API may return errors about not finding the chat.
  • Invalid action or value: The only supported action here is setReadStatus. Providing unsupported actions or malformed values may cause the API to reject the request.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Network or API errors: Check connectivity and API availability if requests fail unexpectedly.

Links and References

Discussion