notebook-folder-controller

Move a folder

Changed on

Reparents the folder within the same notebook, or moves the folder subtree to another notebook when destinationNotebookId is set. Notes keep their folderId pointing at the same folder rows; descendant folders stay under the moved subtree. A same-name folder at the destination returns 409 with FOLDER_NAME_CONFLICT unless merge=true, in which case the source subtree is merged into the existing folder (including cross-notebook moves).

post/api/notebooks/{notebook}/folders/{folder}/move

Request

  • Base URL: (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/notebooks/{notebook}/folders/{folder}/move
  • Auth: none declared

Path parameters

notebookinteger required
folderinteger required

Request body

newParentFolderIdinteger

Target parent folder id. When null or omitted, the folder is moved to notebook root.

destinationNotebookIdinteger

Destination notebook id for a cross-notebook move. When null or omitted, the folder stays in the path notebook.

mergeboolean

When true, merges the folder into an existing same-name sibling at the destination instead of returning 409. Subfolder name clashes are resolved recursively.

Response

OK

Changes

  • b88bb26a237eRevision changes
    • info

      api tag notebook-folder-controller added

    • info

      api tag notebook-controller removed

  • 13f77438750eRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status