Patch filter template attribute

patch

https://navigator-api.tweakwise.com/filtertemplate/{filterTemplateId}/attribute/{attributeId}

Path Params

filterTemplateId

int64

required

Id of the filter template the attribute belongs to

attributeId

int64

required

Id of the attribute

Body Params

Name

string

New text that is shown above the filter

Collapsible

boolean

New value for is the attribute collapsible

Collapsed

boolean

New value for is the attribute collapsed by default

NumberOfValues

int32

New number of values to show

ShowMoreText

string

New text for show more

ShowLessText

string

New text for show less

IsMultipleChoice

boolean

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

Logic

string

enum

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

Allowed:

DisplayFilter

string

enum

New display type of the filter.

Allowed:

NumberOfColumns

int32

New number of columns

ShowNumberOfProducts

boolean

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

ShowIcon

boolean

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

Sequence

int32

New sequence of the attribute

SortingOfValues

string

enum

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

Allowed:

ManualSortingValues

array of strings

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

ManualSortingValues

ManualBackupSorting

string

enum

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

Allowed:

AlternativeSorting

string

enum

New sorting of values when the filter is expanded

Allowed:

ManualAlternativeSortingValues

array of strings

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

ManualAlternativeSortingValues

ManualBackupAlternativeSorting

string

enum

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

Allowed:

ShowExplanation

boolean

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

Explanation

string

New explanation text to show

ShowFilter

boolean

New value for toggle show filter

ShowFilterPercentageThreshold

int32

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

Prefix

string

New prefix

Suffix

string

New suffix

MinDepth

int32

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

MaxDepth

int32

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

ShowSelectedFirst

boolean

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

CssClass

string

New custom css class

HideFilterOnlyOneOption

boolean

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

IsClickPoint

boolean

New value for is Clickpoint toggle

ClickpointList

array of doubles

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

ClickpointList

IsBucket

boolean

New value for is bucket toggle

BucketAmount

int32

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

BucketStepSize

int32

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

SortAutomaticFilterTemplate

boolean

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

SortAutomaticFilterValues

boolean

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.

IsSearchable

boolean

New value for show the search in attributes list

SearchPlaceholder

string

New text that is shown in the search field

SearchNoResultsText

string

New text that is shown when there are no results

NameTranslations

array of objects

New translations for the name

NameTranslations

ShowMoreTextTranslations

array of objects

New translations for the show more text

ShowMoreTextTranslations

ShowLessTextTranslations

array of objects

New translations for the show less text

ShowLessTextTranslations

ExplanationTranslations

array of objects

New translations for the explenation text

ExplanationTranslations

SearchPlaceholderTranslations

array of objects

New translations for the placeholder text

SearchPlaceholderTranslations

SearchNoResultsTextTranslations

array of objects

New translations for the no results text

SearchNoResultsTextTranslations

PrefixTranslations

array of objects

New translations for the prefix text

PrefixTranslations

SuffixTranslations

array of objects

New translations for the suffix text

SuffixTranslations

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

404

FilterTemplate attribute not found

200OK

400BadRequest