DeleteFolder API¶

Deletes the folder at the specified path, including all its contents (subfolders and documents). This operation is permanent and cannot be undone unless items are in the recycle bin.

Endpoint¶

/srv.asmx/DeleteFolder

Methods¶

• GET /srv.asmx/DeleteFolder?authenticationTicket=...&Path=...
• POST /srv.asmx/DeleteFolder (form data)
• SOAP Action: http://tempuri.org/DeleteFolder

Parameters¶

Response¶

Success Response¶

<response success="true" />

Error Response¶

<response error="Access denied." />

Required Permissions¶

The calling user must have delete permission on the folder. The user must also have permission to delete all documents within the folder.

Example¶

GET Request¶

GET /srv.asmx/DeleteFolder
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &Path=/Finance/Reports/2024
HTTP/1.1

POST Request¶

POST /srv.asmx/DeleteFolder HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&Path=/Finance/Reports/2024

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:DeleteFolder>
      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>
      <tns:Path>/Finance/Reports/2024</tns:Path>
    </tns:DeleteFolder>
  </soap:Body>
</soap:Envelope>

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

Deletes a folder and everything under it. There is no recursive flag and no confirmation: a folder with a thousand documents and a tree of subfolders goes in one call, and what it took with it is not reported.

await call('DeleteFolder', {
  authenticationTicket: ticket,
  Path: '/Finance/Reports/2026'
});

Deleting a folder that is not there is a 4041 failure, so a delete that runs twice reports the second attempt rather than passing silently.

Notes¶

• Top-level folders (domains/libraries) cannot be deleted using this API. Use DeleteDomain instead.
• Deleting a folder removes all subfolders and documents within it.
• Depending on server configuration, deleted items may be moved to the recycle bin rather than being permanently deleted.
• Checked-out documents within the folder may prevent deletion unless the user has administrator rights.
• Folder rules (DisallowFolderDelete) may restrict this operation.

Related APIs¶

• CreateFolder - Create a folder
• FolderExists - Check whether a folder exists
• DeleteDomain - Delete a top-level domain/library
• DeleteDocument - Delete a single document

Error Codes¶

The errorCode values this operation returns, checked against a running server:

DeleteFolder refuses an unticketed caller like the other writes, but reports it differently: it answers 4041 "User not found" where the others answer 4010 "Anonymous users cannot perform this action". The refusal is right; only the way it is worded is not, and a client should not read that 4041 as a missing folder.