Folder resource

Delete folder from recycle bin

OVERVIEW

Purpose

API endpoint to delete specific folder from to the recycle/deleted items. The folder will be permanently deleted from the system, and cannot be restored after this action.

Request

DELETE    /folders/{folderid}/recycle

Parameters

 

Parameters Value Description
 sourceclient={sourceclient} (optional) String String to record actions taken by a specific client application, this is useful when used when using the changes API
folderid int

Folderid of the folder to be permanently deleted

 

Response

API endpoint returns a 200 OK in case of a successful operation.

 

Example Response:

DELETE        http://clientinstance.highq.com/clientinstance/api/1/folder/123/recycle

XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<error>

<ref>130</ref>

<summary>Access denied</summary>

</error>

Response Codes

Code Meaning
200/204 Folder deleted successfully.
401 Unauthorized
405 Method not allowed (calling api with wrong method)

 

 

Comments


0 Comments

Last Updated: Nov 08,2024