Intralinks Developer Portal

This API deletes a specified set of folders.


Resource Location

POST /v1/services/workspaces/folders


Authorization Type

HTTP Cookie ssoGlobalSessionID


Request Parameters

Name Description Required Example
method Intralinks call method. Must be set to DELETE Yes method=DELETE
xml XML Document that contains the parameters for the call Yes
workspaceId Integer identifier of the target exchange Yes &workspaceId=123789
deleteFolderContent T or F If deleteFolderContents=F, FolderNotEmptyException will be thrown if folder is not empty. Default is T No &deleteFolderContents=F

XML Body fields

Information about the folder you are creating needs to be submitted in an XML document with the following structure.

<folderDeleteRequest>
 <entityId>
   <id></id>
   <type></type>
   <version></version>
 </entityId>
 <entityId>
   ...
 </entityId>
</folderDeleteRequest>
Name Description Required Example
id The ID number of the target folder to be deleted Yes <id>12345</id>
type The type of the entity Valid Types:
FOLDER
DOCUMENT
WORKSPACEUSER
WORKSPACEGROUP
Yes <type>FOLDER</type>
version The version number for optimistic locking Yes <version>12345qwerty</version>


Example Request

curl -k -X POST
-b "ssoGlobalSessionID=SESSION_ID"
-d "XML_REQUEST" https://test-api.intralinks.com/services/workspaces/folders?method=DELETE&client=CLIENT_ID&workspaceId=WORKSPACE_ID"

Example XML

<folderDeleteRequest> 
    <entityId> 
        <id>123</id> 
        <type>FOLDER</type> 
        <version>234ret5t5</version> 
    </entityId> 
    <entityId> 
        <id>456</id> 
        <type>FOLDER</type> 
        <version>234ret5t5</version> 
    </entityId> 
</folderDeleteRequest> 


Example Response

<folderDeleteResponse> 
    <status> 
        <code>202</code> 
        <message>The entities have been updated</message> 
    </status>
</folderDeleteResponse>