Rename Folder

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

Update the name of an existing folder identified by its unique folder ID. This endpoint supports renaming only.

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> \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-api-key: <your-api-key>' \
--data '{
  "name": "New Folder Name"
}'

Path Parameter

ParameterTypeDescription
folder_idstringUnique identifier of the folder to rename (required)

Request Body Parameters

FieldTypeDescription
namestringNew name for the folder

Response

Response Structure

FieldTypeDescription
folder_idstringUnique identifier of the renamed folder
namestringNew name of the folder
updated_atdatetimeTimestamp of folder rename

Sample Response

json
{
  "folder_id": "folder_789",
  "name": "New Folder Name",
  "updated_at": "2024-01-15T12:30:00Z"
}

Notes

  • Requires API authentication.
  • Folder ID must exist and be accessible.
  • New name must be unique within the same parent folder.
  • Only the folder name can be updated.
  • Folder structure and contents remain unchanged.
  • Refer to Error Responses for error information.

Example Usage

Shell
curl --request POST \
--url https://api.konpro.ai/v1/folders/<folder_id> \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-api-key: <your-api-key>' \
--data '{
  "name": "New Folder Name"
}'

LANGUAGE

CREDENTIALS

HEADER

RESPONSE

Examples

Choose an example:

application/json
200 - Success
401 - Unauthorized