Skip to main content
PUT

Authorizations

​
Authorization
string
header
required

API key in format {id}.{secret}.

The notes an endpoint returns depend on the key type. A user key reaches the notes that user can see in the app, including notes in their own private folders. A system key (workspace or organization, no user identity) reaches only notes that sit in a folder shared with all workspace members. Notes in a private folder, in a folder shared with only some members, or in no folder at all fall outside a system key's read scope, and scopes do not widen that boundary.

List and search endpoints drop out-of-scope notes from the response without an error. Single-note reads and their sub-resources return 404, the same response as a deleted note. See What notes a system key reads.

Path Parameters

​
folderId
string
required

Folder ID to move

Body

application/json

Move a folder under a new parent, or to the root level.

​
newParentId
string | null

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.

Example:

"98765"

​
sharingTypeUpdateStrategy
enum<string>
default:KEEP_EXISTING

How the moved folder's sharing permissions are handled.

  • 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.
Available options:
KEEP_EXISTING,
INHERIT_FROM_PARENT
Example:

"KEEP_EXISTING"

Response

Folder moved

A folder and its metadata.

​
id
string
required

Unique identifier for the folder

Example:

"12345"

​
workspaceGuid
string
required

GUID of the workspace the folder belongs to

Example:

"ws_a1b2c3d4"

​
title
string
required

Folder title (max 50 characters)

Example:

"Weekly Team Meetings"

​
description
string
required

Folder description. Empty string when unset.

Example:

"Notes from our weekly sync"

​
sharingType
enum<string>
required

Who can access a folder and the notes inside it.

  • 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).
Available options:
PRIVATE,
ALL_MEMBER_VIEWER,
ALL_MEMBER_EDITOR,
LIMITED
Example:

"PRIVATE"

​
parentId
string | null
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.

Example:

"12300"

​
color
string
required

Folder color in hex format (#RRGGBB)

Example:

"#4A90D9"

​
isTeamFolder
boolean
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.

Example:

true

​
createdAt
string<date-time>
required

ISO-8601 creation timestamp (UTC)

Example:

"2025-01-15T10:30:00Z"

​
updatedAt
string<date-time>
required

ISO-8601 last-update timestamp (UTC)

Example:

"2025-01-18T14:20:00Z"