Chatwoot icon

Chatwoot

Interact with Chatwoot API to manage conversations, messages, contacts, and more

Actions206

Custom Filter → Create

AI-generated

Summary

Create a custom filter in Chatwoot of specified type by providing a name and a JSON query representing the filter criteria.

Inputs

  • Filter Type — Select the type of custom filter to create, such as Conversation, Contact, or Report. Defaults to Conversation.
  • Name (required) — Enter the name for the custom filter.
  • Query (JSON) (required) — Supply the filter query as a JSON object defining the filter criteria.

Output shape

a single JSON object representing the newly created custom filter with its details

The output contains the created custom filter data returned from Chatwoot, reflecting the filter type, name, and query as specified.

Examples

Example 1: Create a conversation custom filter named 'Open Tickets' with a query filtering open status conversations

Set Filter Type to 'Conversation', Name to 'Open Tickets', and Query to appropriate JSON filtering open status

Links

Discussion