Rename or move a folder
Send exactly one of name to rename in place, or parentId to move. A move takes the whole subtree and every id in it survives, so ids held by a client stay valid; the paths below it change. Sending both, or neither, is rejected rather than resolved by a precedence rule.
Authorizations
Workspace-scoped API key, sent as a bearer token. The recommended header. The workspace is implicit in the key and never appears in a URL.
Path Parameters
The folder id, as an earlier response reported it. Always dir_….
"dir_9f2k1x8b3m7q0v"
Body
- Rename
- Move
Rename the folder in place. The id and the parent do not change.
New leaf name, which renames the folder in place. Send instead of parentId, never with it.
"initiatives"
Response
The folder after the change. Its id, and every id below it, is unchanged.
Type discriminator. Always folder.
folder Stable id. Survives a rename or a move.
"dir_9f2k1x8b3m7q0v"
Leaf name, without any part of the path.
"reports"
The containing folder, or null when this folder sits at the root.
"dir_4k1n8p2v5m7q0x"
Path of the containing folder. / at the root.
"/projects"
Live folder location. Changes when the folder moves.
"/projects/reports"
When true, a change to any file inside this folder goes to review instead of being accepted automatically, however the file itself is flagged.
When the folder was created.
"2026-07-01T09:12:00.000Z"
When the folder was last updated.
"2026-08-01T14:03:00.000Z"