Docmost Octri Preview
POST/spaces/watch

Subscribe to space updates

Subscribes the authenticated user to updates for a space. Supply spaceId to identify the space 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 space to watch.

spaceIdstringrequired
Space identifier.

3 status codes
200Returns the space's watch state after the change.
dataobjectoptional
statusintegeroptional
successbooleanoptional
403Returned when watching the space is forbidden.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the space 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 space. A 404 is returned when no space exists with the supplied spaceId.