Unshare Folder
delete
/documents/api/1.2/shares/{folderId}
Remove all shares from a specified folder.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
folderId: string
Globally unique identifier (GUID) for the folder. If the referenced folder is the user's home folder, the value for
.folderId
isself
Query Parameters
-
message(optional): string
Optional message sent to the user.
Response
Supported Media Types
- application/json
- application/xml
200 Response
The request was fulfilled.
Example Response (application/json)
{
"id":"F1321DC48E3B123D02DBEE88T0000000000100000001",
"type":"share",
"errorCode":"0"
}
400 Response
Request parameters are not formatted correctly.
403 Response
Forbidden if the user does not have read permission.
404 Response
Folder ID is not found.
Examples
The following example removes all shared access to the specified folder.
DELETE .../shares/F1321DC48E3B123D02DBEE88T0000000000100000001?message=Removing all shared access to this folder
Request Header
None.
Request Body
None.
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{ "errorCode": "0", "id": "F1321DC48E3B123D02DBEE88T0000000000100000001", "type": "share" }