Folders

Update a folder

Update a folder's name, description, parent, or access-control flag. At least one field must be provided. System folders cannot be modified.

Org-scoped keys can update non-access-controlled folders.

patch/folders/{id}

Request

Path parameters

idstring uuid required

The folder ID

Request body

namestring

New folder name (minimum 2 characters)

descriptionstring

New folder description

parent_folder_idstring uuid

Target parent folder ID. The destination must not be the folder itself or one of its descendants.

is_access_controlledboolean

Whether the folder requires explicit access grants

Response

Folder updated successfully

idstring uuid required

Unique folder identifier

namestring required

Folder name

descriptionstring nullable required

Folder description, or null if unset

pathstring required

Path through ancestors visible to the requester. Inaccessible ancestors are skipped, so this may not reflect absolute depth. Use parent_folder_id to traverse hierarchy.

parent_folder_idstring uuid nullable required

Parent folder ID, or null for root

folder_typestring required

Folder type (custom, my-files, etc.)

created_atstring required

ISO 8601 creation timestamp

Example response

{
  "path": "/My Files/Contracts"
}

Changes

No recorded changes to this operation across all 1 revision of this API.