Docmost Octri Preview
POST/shares/delete

Delete a share

Deletes a share identified by its ID. Supply shareId to specify the share to remove. The operation requires permission to manage that share.

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

1 body field

The identifier of the share to delete.

shareIdstringrequired
ID of the share.

3 status codes
200Returns a success response confirming that the share was deleted.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
403Returned when the authenticated user is not permitted to delete the share.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the specified share 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 delete the share. A 404 is returned when the share identified by shareId does not exist. Supply shareId in the request body.