v1

latestOpenAPI 3.0.02026-07-24182211348.4 KB

Filter templates

Patch filter template attribute

patch/filtertemplate/{filterTemplateId}/attribute/{attributeId}

Path parameters

filterTemplateIdinteger required

Id of the filter template the attribute belongs to

attributeIdinteger required

Id of the attribute

Request body

Namestring

New text that is shown above the filter

Collapsibleboolean

New value for is the attribute collapsible

Collapsedboolean

New value for is the attribute collapsed by default

NumberOfValuesinteger

New number of values to show

ShowMoreTextstring

New text for show more

ShowLessTextstring

New text for show less

IsMultipleChoiceboolean

New value for is multiple choice, in case of 'DisplayFilter' being 'checkbox' or 'color'

Logic'OR' | 'AND'

New logic in case of 'DisplayFilter' being 'checkbox' or 'color'.

New display type of the filter.

NumberOfColumnsinteger

New number of columns

ShowNumberOfProductsboolean

New value for show the number of products that remains after the value has been selected

ShowIconboolean

New value for enclose a tag that can be replaced by an image in the front-end application

Sequenceinteger

New sequence of the attribute

New order in which the values of this filter are sorted. By using manual sorting, it is even possible to determine the order

ManualSortingValuesstring[]

New ordered list of values when 'SortingOfValues' is set to 'manual'

New backup sorting method of remaining values when 'SortingOfValues' is set to 'manual'

New sorting of values when the filter is expanded

ManualAlternativeSortingValuesstring[]

New ordered list of values when 'AlternativeSorting' is set to 'manual'

New backup sorting method of remaining values when 'AlternativeSorting' is set to 'manual'

ShowExplanationboolean

New value for show explanation/help text for the filter.

Explanationstring

New explanation text to show

ShowFilterboolean

New value for toggle show filter

ShowFilterPercentageThresholdinteger

New threshold percentage. Between 5 and 100 in increments of 5%

Prefixstring

New prefix

Suffixstring

New suffix

MinDepthinteger

New min depth for category or tree (Attribute source type)

MaxDepthinteger

New max depth for category or tree (Attribute source type)

ShowSelectedFirstboolean

New value for when a value has been selected, this appears at the top of the list, irrespective of the selected sorting

CssClassstring

New custom css class

HideFilterOnlyOneOptionboolean

New value for hide filter when there is only one option available.

IsClickPointboolean

New value for is Clickpoint toggle

ClickpointListnumber[]

New list of clickpoints for when DisplayFilter is set to 'ClickpointBucketSlider' and IsClickPoint is true.

IsBucketboolean

New value for is bucket toggle

BucketAmountinteger

New amount of buckets for when DisplayFilter is set to 'ClickpointBucketSlider' and IsBucket is true.

BucketStepSizeinteger

New minimal bucket step size for when DisplayFilter is set to 'ClickpointBucketSlider' and IsBucket is true.

SortAutomaticFilterTemplateboolean

New value for automatically determine where the filter is placed on the filter template based on usage.

SortAutomaticFilterValuesboolean

New value for automatically sort the filter values based on usage. If there is not enough data, the ‘sorting the values’ selected below is used.

IsSearchableboolean

New value for show the search in attributes list

SearchPlaceholderstring

New text that is shown in the search field

SearchNoResultsTextstring

New text that is shown when there are no results

Response