Actions112
- Account Actions
- Account AgentBot Actions
- Agent Actions
- Audit Log Actions
- Automation Rule Actions
- Canned Response Actions
- Contact Actions
- Contact Label Actions
- Conversation Actions
- Conversation Assignment Actions
- Custom Attribute Actions
- Custom Filter Actions
- Help Center Actions
- Inbox Actions
- Integration Actions
- Label Actions
- Message Actions
- Profile Actions
- Report Actions
- Account Conversation Metrics
- Account Reporting Events
- Agent Conversation Metrics
- Get Account Reports
- Get Account Reports Summary
- Get Conversation Statistics Grouped by Agent
- Get Conversation Statistics Grouped by Channel Type
- Get Conversation Statistics Grouped by Inbox
- Get Conversation Statistics Grouped by Team
- Get First Response Time Distribution by Channel
- Get Inbox-Label Matrix Report
- Get Outgoing Messages Count Grouped by Entity
- Team Actions
- Webhook Actions
Custom Filter → Create a Custom Filter
AI-generatedSummary
Create a new custom filter for a specified ChatWoot account by providing the account ID and optional details such as name, query, and type.
Inputs
- Account ID (required) — The numeric ID of the ChatWoot account for which the custom filter will be created.
- Name — The name of the custom filter to identify it.
- Query — A JSON query defining the filter criteria to be saved.
- Type — The category of the custom filter, which can be 'conversation', 'contact', or 'report'.
Output shape
a single JSON object representing the newly created custom filter
The output contains the created custom filter's data as returned by the ChatWoot API. Optional request parameters like batching, proxy, timeout, and SSL allowance can affect the request behavior but not the output shape.
Examples
Example 1: Create a filter named 'Urgent Conversations' for account ID 123 with a query targeting urgent messages and type set to 'conversation'.
Set Account ID to 123, Name to 'Urgent Conversations', Query as appropriate JSON, and Type to 'conversation'.