Delete

This endpoint deletes a folder. It supports both soft (move to trash) and hard (permanent) deletion.

Endpoint: /folder/delete/{folderId}

Method: DELETE

Path Parameters:

folderId (required): The ID of the folder to be deleted. Example: f7a8b9c0-d1e2-3f4a-5b6c-7d8e9f0a1b2c

Request Body Parameters:

{
  "trash": "soft" // or "hard"
}

trash (optional, string, default: "soft"): Specifies the type of deletion.

"soft": Moves the folder to the trash (soft delete).

"hard": Permanently deletes the folder (hard delete).

Example Request (Soft Delete):

DELETE /folder/delete/f7a8b9c0-d1e2-3f4a-5b6c-7d8e9f0a1b2c
Content-Type: application/json

{
  "trash": "soft"
}

This request moves the folder with ID f7a8b9c0-d1e2-3f4a-5b6c-7d8e9f0a1b2c to the trash.

Example Request (Hard Delete):

DELETE /folder/delete/f7a8b9c0-d1e2-3f4a-5b6c-7d8e9f0a1b2c
Content-Type: application/json

{
  "trash": "hard"
}

This request permanently deletes the folder with ID f7a8b9c0-d1e2-3f4a-5b6c-7d8e9f0a1b2c.

Example Request (Using Default Soft Delete):

DELETE /folder/delete/f7a8b9c0-d1e2-3f4a-5b6c-7d8e9f0a1b2c

This request moves the folder with ID f7a8b9c0-d1e2-3f4a-5b6c-7d8e9f0a1b2c to the trash (using the default soft delete behavior).

Response Codes:

200 OK: Folder successfully deleted (either soft or hard).

204 No Content: Folder successfully deleted (alternative for successful deletion, especially for hard deletes).

400 Bad Request: Invalid request body (e.g., invalid trash value).

404 Not Found: Folder not found.

500 Internal Server Error: Server error.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request