Sign in

v1

latestOpenAPI 3.0.12026-07-1714724311.1 KB
Presets

Update a Preset

Update an existing preset.

patch/presets/{id}

Path parameters

idinteger required

Index

Query parameters

fieldsstring[]

Control what fields are being returned in the object.

metastring

What metadata to return in the response.

Request body

collectionstring required

What collection this collection preset is used for.

titlestring

Name for the bookmark. If this is set, the collection preset will be considered to be a bookmark.

roleinteger

The unique identifier of a role in the platform. If user is null, this will be used to apply the collection preset or bookmark for all users in the role.

search_querystring

What the user searched for in search/filter in the header bar.

view_typestring

Name of the view type that is used. Defaults to tabular.

view_querystring

View query that's saved per view type. Controls what data is fetched on load. These follow the same format as the JS SDK parameters.

view_optionsstring

Options of the views. The properties in here are controlled by the layout.

translationobject

Key value pair of language-translation. Can be used to translate the bookmark title in multiple languages.

Example request

{
  "collection": "articles",
  "title": "Highly rated articles",
  "filters": [
    {
      "field": "rating",
      "operator": "gte"
    }
  ]
}

Response

Successful request