Sign in

v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB
Folders

Update Folder

Allows the requester to modify certain fields on a folder.

When updating the parent field, the folder moves to the new parent location while its contents remain intact. The requesting user must have both edit and share access to both the old and new parent folders, or the entire update will fail.

It is not permitted to update the parent field on Team Folders. Moving folders into or out of Team Folders may encounter permission-related errors, but once a folder is within a Team Folder, reorganization among descendants within that Team Folder can proceed without permission issues.

patch/v1/folders/{id}

Path parameters

idnumber required

ID of the folder to be updated.

Request body

namestring

New name for the folder being updated.

parentnumber nullable

New parent for the folder being updated. Causes the folder to be moved into another folder if an ID is provided or into the user's root folder ("My Documents") if null is provided. If the parent field is not included in the request, the folder will not be moved. Cannot be provided for Team Folders.

Response

OK with a Folder resource containing information about the updated folder.

idnumber required

Unique ID of the folder

type'folder' | 'team' required
  • folder - Folders can live in other folders, team folders, or the root of a user’s folder manager ("My Documents"). A folder in "My Documents" will have a null parent field.
  • team - Team folders can never live in another folder and are always located in the "Team Folders" section of a user's folder manager. Team folders will not have a parent field. Learn more
namestring required

Name of the folder

parentnumber nullable

ID of the parent folder.

createdstring date-time required

Date and time of when the folder was created

trashedstring date-time

Date and time of when the folder was trashed

Example response

{
  "id": 123456789,
  "type": "folder",
  "name": "Folder Name",
  "parent": 123456788,
  "created": "2020-06-26T16:29:37Z",
  "trashed": "2022-01-20T12:14:18Z",
  "attributes": [
    {
      "name": "Sample Label",
      "value": "Sample Value"
    }
  ]
}