Docmost Octri Preview
POST/bases/views/create

Create a view on a base

Creates a view on a base with a name and optional type and configuration. Supply pageId and name; use config to set view settings, including property order, filters, and sorts.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

The base view to create. Supply pageId and name; config and type are optional.

configobjectoptional
View configuration. Unknown keys are preserved. `groupByPropertyId`, `hiddenChoiceIds`, and `choiceOrder` apply to kanban views only.
namestringrequired
The name of the view.
pageIdstringrequired
Id of the base. A base *is* a page, so this is the base's page id - the same id you would pass to the page endpoints.
typestringoptional
The view type: `table`, `kanban`, or `calendar`.
Allowed:tablekanbancalendar

4 status codes
200Returns the created view object.
dataobjectoptional
statusintegeroptional
successbooleanoptional
400Returned when the request fails validation.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
403Returned when access is forbidden or bases are not included in the current licence.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the base is not found.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when the request fails validation. A 403 is returned when access is forbidden or bases are not included in the current licence, and a 404 is returned when the base is not found. pageId and name are required; pageId must be a UUID, and type, if supplied, must be table, kanban, or calendar.