Apply Filters Template

Overview

Run the Apply Filters Template action from a handler.

This action loads a saved Filter Template, substitutes values, and applies it. It replaces all currently active filters.

Handlers and actions

• Handler: defines what happens when a user clicks a Kanban UI element.

• Action: an executable operation triggered by the handler.

• Primary action here: Kanban API → Apply Filters Template.

• Optional follow-ups: configure extra actions on success or failure.

See Configuring Handlers.

Key concepts

Filter Template A saved set of filter conditions. Templates can contain placeholders populated at runtime.

Filter Panel The panel where active filter conditions are displayed and managed.

Configuration

Configure the handler on the interactive element.

Primary action type Kanban API

Primary action Apply Filters Template

Action parameters JSON object used to select the template and provide substitution values.

This action replaces the current Filter Panel state. Use Merge Filters Template to keep existing filters.

Parameters

Name	Description	Required
template	The name of the Filter Template to load.	Yes
showPanel	When true, opens the Filter Panel after applying the filters. Default: false.	No
values	JSON object containing values used to populate filter items defined in the template.	No

values notes

• Keys must match the template’s field names.

• Values can be static values or runtime expressions.

Example

{
  "template": "My Template A",
  "showPanel": true,
  "values": {
    "Opportunity.AccountId": "{Opportunity.AccountId}",
    "Opportunity.StageName": "Prospecting",
    "Opportunity.CloseDate": "{$System.Today}"
  }
}

Behavior

When the handler runs the action:

1. Retrieves the filters list from the specified Filter Template.

2. Applies provided values to the template filter items.

3. Replaces all existing active filters in the Filter Panel with the result.

4. Applies conditions automatically.

5. If showPanel is set to true, opens the Filter Panel as a side effect.

---

Related actions

• Select Filters Template (load into the panel, no auto-apply)

• Merge Filters Template (merge into existing panel filters)

• Apply Filters Template Conditions (apply as hidden conditions)

• Clear Hidden Conditions (clear hidden conditions)

• Apply Filter Conditions (equivalent to clicking Apply)

Troubleshooting

No filters are applied after clicking the element. The template value may reference a missing template. Names are case-sensitive.

The Filter Panel does not open. showPanel defaults to false. Set it to true to open the panel after applying.

Template values are not substituted. Keys in values must match the template’s field names. Use API names like Opportunity.StageName.

Existing filters are removed. This is expected. Use Merge Filters Template to preserve user filters.

Dynamic expressions in values are not resolving. Expressions like {Opportunity.AccountId} resolve only when that context exists. Place the element where the referenced fields are available.