1. REST API for Content Management 1.1
  2. Tasks
  3. Shares

Unshare Folder

delete

/documents/api/1.1/shares/{folderId}

Remove all shares from a specified folder.

Request

Supported Media Types
  • application/json
  • application/xml
Path Parameters
folderId
Type: string
Required: true

Globally unique identifier (GUID) for the folder. If the referenced folder is the user's home folder, the value for folderId is self

.
Body Parameter
The request body defines details of the unshare folder request. There are no required attributes.
Root Schema : UnshareFolderBody
The request body defines details of the unshare folder request. There are no required attributes.
Example application/json

{
    "message":"Removing all shared access to this folder."
}

Response

Supported Media Types
  • application/json
  • application/xml
200 Response

The request was fulfilled.

Body
The response body includes information about the unshare folder operation.
Root Schema : UnshareFolderResponse
The response body includes information about the unshare folder operation.
Example 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

Request Header

None.

Request Body

{
    "message": "Removing all shared access to this folder"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "id": "F1321DC48E3B123D02DBEE88T0000000000100000001",
    "type": "share"
}