Docmost Octri Preview
POST/bases/update

Update a base's name, description, or icon

Updates the name, description, or icon of an existing base. Supply its page ID as pageId and include the fields you want to change. A base uses the same ID as its page.

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

4 body fields

The base identifier and any name, description, or icon fields to update.

descriptionstringoptional
The description to set for the base.
iconstringoptional
The icon to display for the base.
namestringoptional
The name to set for the base.
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.

3 status codes
200Returns the updated base.
dataobjectoptional
A base is a page with `isBase` set - it carries the page fields plus base metadata, and there is no separate base id. Its `id` is the page id, which is what every base endpoint takes as `pageId`.
statusintegeroptional
successbooleanoptional
403Returned when updating the base 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 403 is returned when the authenticated user is forbidden from updating the base or bases are not included in the current licence. A 404 is returned when no base exists with the supplied pageId. pageId must be a UUID identifying the base's page.