Commands  ›   ›  Edit Filter Properties

Edit Filter Properties

writes to model Public API · not yet exposed

Coming soon

Before you run this

Active document must be open. Target filter must exist by name.

After it runs

The filter element is renamed and/or has its categories updated.

When to use this

Don't use this when

Creating new filters (use a create filter command). Not for view filter overrides.

Inputs

NameKindTypeRequiredDefaultDescription
filterName config string no Existing filter name
newName config string no Optional new filter name
categories config string no Optional comma-separated BuiltInCategory names

Returns

NameTypeDescription
ResultJSONFilter edit result including id, name, categoryCount

What you'll see in the chat

on start
Editing filter properties...
Updating the view filter...
thinking
Looking up filter by name...
Applying name change if requested...
Parsing and setting category assignments...
on success
Filter "{name}" updated — now has {categoryCount} categories
on failure
Could not edit filter: {error}

REST API

Not yet exposed

This command does not carry a [RestApi] attribute today. Once tagged, this section will auto-populate with:

  • POST /api/v1/commands/edit_filter_properties
  • Request body schema (from [RestApiParam])
  • Response schema (from [RestApiResponse])
  • curl / JS / Python code examples

Keywords & intent patterns

edit filter properties · rename filter · set filter categories · update filter · change filter name
Patterns: edit * filter · rename * filter · set * filter * categories · update * filter

Related commandsListFilters
Pillar