CLclickup
Folders

Update Folder

Changed on

Rename a Folder. Renaming a subfolder leaves it nested inside its parent Folder, and the response includes the parent_folder field.

This endpoint only renames a Folder. To nest a Folder inside another Folder or move it to another Space, use the Move Folder endpoint; a parent_folder_id sent to this endpoint is ignored.

put/v2/folder/{folder_id}

Request

  • Base URL
    https://api.clickup.com/api
  • URL
    https://api.clickup.com/api/v2/folder/{folder_id}
  • Auth
    API key in header Authorization

Path parameters

folder_idnumber required
Example:457

Request body

namestring required

Example request

{
  "name": "Updated Folder Name"
}

Response

idstring required
namestring required
orderindexinteger required
override_statusesboolean required
hiddenboolean required
spaceSpace required(unresolved $ref)
task_countstring required
archivedboolean

Whether the Folder is archived.

statusesItems[] (unresolved $ref)

Statuses defined on this Folder. Only populated when override_statuses is true. A Folder that inherits its statuses returns an empty array here; its effective statuses are those of its nearest ancestor Folder that overrides them, or of the Space when no ancestor does. To get the resolved statuses for the Folder, request it with Get Folder.

parent_folderstring

ID of the parent Folder if this Folder is a subfolder. Only present when the Folder is nested inside another Folder.

Example response

{
  "id": "457",
  "name": "Updated Folder Name",
  "orderindex": 0,
  "override_statuses": false,
  "hidden": false,
  "space": {
    "id": "789",
    "name": "Space Name",
    "access": true
  },
  "task_count": "0",
  "statuses": []
}

Changes

  • a0a72ec97ddbRevision changes
    • breaking

      the response's property type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status