ChatWootInstall

Summary

Create a new custom filter in a specified ChatWoot account by providing the account ID, filter name, type, and query definition.

Inputs

• Account Id (required) — Numeric ID of the ChatWoot account where the custom filter will be created.
• Filter Type — Type of custom filter to create; options are conversation, contact, or report (sent as query parameter). Defaults to conversation.
• Name — The name to assign to the new custom filter.
• Type — The category type of the custom filter; options are conversation, contact, or report. Defaults to conversation.
• Query — JSON object that defines the query conditions for the custom filter.
• Request Options — Optional settings to adjust request behavior, including batching, SSL validation, proxy, and timeout.

Output shape

a single JSON response object representing the created custom filter

The output is the API response for the newly created custom filter. The shape of the response depends on ChatWoot API. No pagination applies since this is a create action.

Examples

Example 1: Creating a conversation-type custom filter with a specific query in account 12345

Set Account Id to 12345; set Filter Type and Type to 'conversation'; provide a filter Name and a JSON query string.