Skip to main content

CreateFilterPresetRequest

Request body for creating a new filter preset.

conditionobjectrequired

The saved condition. Must parse as SeriesCondition when target = "series" and as BookCondition when target = "books".

libraryIdstring,null<uuid>nullable

Optional library scope; None means the preset applies globally.

namestringrequired
querystring | nullnullable

Optional saved text query (only meaningful for scope = "search" or list pages that have a search box).

scopestringrequired

Where this preset is used: "list" or "search".

sortstring | nullnullable

Optional saved sort key, mirrors the URL sort query parameter (e.g. "title:asc", "year:desc", "relevance").

targetstringrequired

Target entity: "series" or "books".

CreateFilterPresetRequest
{
"condition": {},
"libraryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"query": "string",
"scope": "string",
"sort": "string",
"target": "string"
}