Docmost Octri Preview
POST/shares/update

Update share settings

Updates settings for an existing share. Supply shareId and optionally change whether sub-pages are included, whether search engines can index the page, or which page is shared.

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

4 body fields

Share identifier and optional settings to update.

includeSubPagesbooleanoptional
If `true`, the share includes the entire sub-page tree. If `false`, only the root page is shared.
pageIdstringoptional
Update the shared page (rarely used).
searchIndexingbooleanoptional
If `true`, search engines can index the page. If `false`, adds `noindex` meta tag.
shareIdstringrequired
ID of the share to update.

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

Error handling

shareId is required. A 403 is returned when the update is forbidden, and a 404 is returned when the share cannot be found.