Docmost Octri Preview
POST/bases/delete

Delete a base

Deletes an existing base identified by its page ID. Supply the base's pageId, which is the same ID used for the base's page. The authenticated user must have permission to delete the base.

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

1 body field

The identifier of the base to delete.

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 a response confirming that the base was deleted.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
403Returned when deleting 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 deleting 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.