Docmost Octri Preview
POST/shares/create

Create a public share for a page

Creates a public share for a page. Supply pageId and optionally enable includeSubPages to share the page tree or searchIndexing to allow search engines to index the page.

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

3 body fields

Page to share and optional settings for sub-pages and search engine indexing.

includeSubPagesbooleanoptional
If `true`, the share includes the entire sub-page tree. Visitors can navigate child pages. If `false` (default), only the specified page is shared.
pageIdstringrequired
ID of the page to share publicly.
searchIndexingbooleanoptional
If `true`, search engines are allowed to index the shared page (adds `index` meta tag). If `false` (default), adds `noindex` meta tag to prevent crawling.

3 status codes
200Returns the created share.
dataobjectoptional
statusintegeroptional
successbooleanoptional
403Returned when sharing is forbidden or disabled.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the page cannot be found.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

pageId is required. A 403 is returned when sharing is forbidden or disabled, and a 404 is returned when the page cannot be found.