KonPro Logo

Trash Folder

POSThttps://api.konpro.ai/v1/folders/{folder_id}/trash

Move an existing folder to the trash. This action marks the folder as trashed without permanently deleting it.

Request History

Log in to see full request history

TIMESTATUSUSER AGENT
Make a request to see history.

0 Requests This Month

cURL Request

shell
curl --request POST \
--url https://api.konpro.ai/v1/folders/<folder_id>/trash \
--header 'accept: application/json' \
--header 'x-api-key: <your-api-key>'

Path Parameter

ParameterTypeDescription
folder_idstringUnique identifier of the folder to trash (required)

Response

Response Structure

FieldTypeDescription
folder_idstringUnique identifier of the trashed folder
statusstringStatus of the folder ("trashed")
trashed_atdatetimeTimestamp when folder was trashed

Sample Response

json
{
  "folder_id": "folder_789",
  "status": "trashed",
  "trashed_at": "2024-01-15T12:45:00Z"
}

Notes

  • Requires API authentication.
  • Folder ID must exist and be accessible.
  • Trashed folders are not permanently deleted.
  • Trashed folders can be restored using the restore endpoint.
  • Folder contents are also moved to trash.
  • This action cannot be undone without using restore.
  • Refer to Error Responses for error information.

Example Usage

Shell
curl --request POST \
--url https://api.konpro.ai/v1/folders/<folder_id>/trash \
--header 'accept: application/json' \
--header 'x-api-key: <your-api-key>'

LANGUAGE

CREDENTIALS

HEADER

RESPONSE

Examples

Choose an example:

application/json
200 - Success
401 - Unauthorized
Rename FolderRestore Folder