Types

FolderUpdate

The body that changes a folder. Send only the fields you change.

name
string
The new name. A live sibling can't have the same name; a locked folder can't be renamed.
parent_id
string (uuid)
The folder to move it into. It must be a folder you can see, and not the folder itself or one of its subfolders. Permissions inherited from the old ancestors are stripped and the new ones inherited, through subfolders and documents.
metadata
object | null
Keys to merge into the folder's metadata. A null value removes that key.
locked
boolean
Whether the folder is locked. Send false to unlock it, which the platform never does.
hidden
boolean
Whether the folder is hidden.
pinned
boolean
Whether the folder is pinned.
released
boolean
Whether its documents are released to the people it is shared with. Recomputed through subfolders and documents.
access
object
Groups of users who may read and write the folder without being listed in its permissions. Granting a group reaches subfolders and documents through inheritance. On update only the keys you send change.

Used by (1)