Jump to

• Request
• Response
• Examples

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 is self

  .

Query Parameters

• message(optional): string
  Optional message sent to the user.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : UnshareFolderResponse

Type: object

The response body includes information about the unshare folder operation.

Show Source

• errorCode(optional): string
  An error code of zero (0) indicates no errors.
• id(optional): string
  Globally unique identifier (GUID) for the folder.
• type(optional): string
  Item type share.

{
    "description":"The response body includes information about the unshare folder operation.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the folder."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>share</code>."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

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.

Back to Top

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"
}

Back to Top