Docmost Octri Preview
POST/pages/watch

Subscribe to page updates

Subscribes the authenticated user to updates for a page. Supply pageId to identify the page whose updates you want to follow.

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

1 body field

The identifier of the page to watch.

pageIdstringrequired
Page identifier.

3 status codes
200Returns the page's watch state after the change.
dataobjectoptional
statusintegeroptional
successbooleanoptional
403Returned when watching the page is forbidden.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the page does not exist.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 403 is returned when the authenticated user is not permitted to watch the page. A 404 is returned when no page exists with the supplied pageId.