v1

latestOpenAPI 3.1.02026-07-226875162.5 KB

Folder

Move Folder

Move a folder under a new parent, or to the root level with newParentId: null. The target parent must be in the same workspace and you must have access to it. You cannot move a folder into its own subtree.

Use sharingTypeUpdateStrategy to control how the folder's sharing permissions are handled after the move (defaults to KEEP_EXISTING).

Requires edit access to the folder.

put/v1/external/folders/{folderId}/move

Path parameters

folderIdstring required

Folder ID to move

Request body

newParentIdstring nullable

Target parent folder ID. Omit or set to null to move the folder to the root level. The target parent must be in the same workspace and you must have access to it.

sharingTypeUpdateStrategy'KEEP_EXISTING' | 'INHERIT_FROM_PARENT'

How the moved folder's sharing permissions are handled.

Strategy	Behavior
KEEP_EXISTING	Keep the folder's current sharingType.
INHERIT_FROM_PARENT	Adopt the new parent folder's sharingType.

KEEP_EXISTING: The folder retains its current access control after the move.
INHERIT_FROM_PARENT: The folder adopts its new parent's sharingType and its member list. You must have access to the new parent. Moving to the root level (newParentId: null) has no parent to inherit from, so the folder keeps its existing sharingType.

Example request

{
  "newParentId": "98765",
  "sharingTypeUpdateStrategy": "KEEP_EXISTING"
}

Response

Folder moved

idstring required

Unique identifier for the folder

workspaceGuidstring required

GUID of the workspace the folder belongs to

titlestring required

Folder title (max 50 characters)

descriptionstring required

Folder description. Empty string when unset.

sharingType'PRIVATE' | 'ALL_MEMBER_VIEWER' | 'ALL_MEMBER_EDITOR' | 'LIMITED' required

Who can access a folder and the notes inside it.

Type	View	Edit
PRIVATE	Only you	Only you
ALL_MEMBER_VIEWER	All workspace members	No member-wide edit access
ALL_MEMBER_EDITOR	All workspace members	All workspace members
LIMITED	Invited members only	Invited members only (per-member role)

PRIVATE: Personal folder. Not shared with the workspace.
ALL_MEMBER_VIEWER: Every workspace member can view; no member-wide edit access is granted.
ALL_MEMBER_EDITOR: Every workspace member can view and edit.
LIMITED: Only explicitly invited members can access, each with an individual role (VIEWER or EDITOR).

parentIdstring nullable required

Parent folder ID. null for root-level folders. In the List Folders response, parentId is also null when the parent folder is not accessible to you.

colorstring required

Folder color in hex format (#RRGGBB)

isTeamFolderboolean required

true when the folder is shared with the workspace (any sharingType except PRIVATE); false for PRIVATE folders. Retained for backward compatibility — use sharingType for the precise access level.

createdAtstring date-time required

ISO-8601 creation timestamp (UTC)

updatedAtstring date-time required

ISO-8601 last-update timestamp (UTC)

Example response

{
  "id": "12345",
  "workspaceGuid": "ws_a1b2c3d4",
  "title": "Weekly Team Meetings",
  "description": "Notes from our weekly sync",
  "sharingType": "PRIVATE",
  "parentId": "12300",
  "color": "#4A90D9",
  "isTeamFolder": true,
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-18T14:20:00Z"
}