Help Search

Edit on github

Delete a folder

A Folder can only be deleted if the current user has the owner permission on the folder. A Folder can be deleted by sending a DELETE request to /folders/<folderUuid>.json

DELETE /folders/<folderUuid>.json

When doing a cascade delete, if the user does not have permission to delete one or more children, they will be ignored and send back at the root.

Request

The request can contain optionally:

Parameter Description Required Validation Constraints
cascade If contained elements should also be deleted False Boolean (default false)

Possible responses

Code Description
200 OK
Folder deleted successfully.
400 Bad Request
The folderId supplied is not a valid UUID
403 Authentication Failure
The user making the request is not authenticated
404 Not Found
The folder either does not exist or the user making the request does not have delete permission.

Examples

Successful request

And a valid request body will look like:

DELETE /folders/b6cfc5e5-138d-467a-a615-a852f1c747ae.json?cascade=1

Success response

{
    "header": {
        "id": "90b88f52-47ef-43a2-b245-32f01ab497da",
        "status": "success",
        "servertime": 1619764339,
        "action": "370391a0-e18e-53ee-b8af-f8583d9a61b5",
        "message": "The folder has been deleted successfully.",
        "url": "\/folders\/b6cfc5e5-138d-467a-a615-a852f1c747ae.json?cascade=1",
        "code": 200
    },
    "body": null
}

Last updated

This article was last updated on April 29th, 2021.

For another perspective on the API you browse the OpenAPI 2.0 specifications using the dedicated API reference site (Swagger UI).

API Reference

You can also find the latest OpenAPI 2.0 specifications directly on the dedicated repository.

OpenAPI Specs repository