ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Custom Filters → Update A Custom Filter

AI-generated

Overview

This node interacts with the ChatWoot API to update an existing custom filter associated with a specific account. Custom filters in ChatWoot allow users to save complex queries for conversations, contacts, or reports, enabling quick access to frequently used filtered views.

Typical use cases include:

  • Modifying saved conversation filters to reflect new criteria.
  • Updating contact filters to segment users differently.
  • Adjusting report filters to change the data scope for analytics.

For example, a user might update a custom filter named "Open Conversations" to include only conversations from VIP customers by changing the query parameters.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account where the custom filter exists.
Custom Filter Id The numeric ID of the custom filter that needs to be updated.
Name The new name for the custom filter.
Type The category of the custom filter. Options: Conversation, Contact, Report.
Query A JSON object representing the filter query to be saved. This defines the filter logic.

Output

The node outputs the response from the ChatWoot API after updating the custom filter. The json output field contains the updated custom filter details as returned by the API, typically including fields such as the filter's ID, name, type, and query.

No binary data is produced by this node.

Dependencies

  • Requires an active connection to the ChatWoot API.
  • Needs an API authentication token configured in the node credentials.
  • The base URL for the ChatWoot instance must be set in the credentials.

Troubleshooting

  • Invalid Account or Filter ID: If the provided account or custom filter ID does not exist, the API will return an error. Verify IDs are correct.
  • Malformed Query JSON: The Query property must be valid JSON. Invalid JSON will cause parsing errors.
  • Authentication Errors: Ensure the API key/token is valid and has sufficient permissions to update custom filters.
  • Network Issues: Connectivity problems with the ChatWoot server can cause timeouts or failures.

Common error messages usually indicate invalid input or authorization issues. Double-check all inputs and credentials if errors occur.

Links and References

Discussion