Skip to main content
PATCH

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

Body

application/json

Partial update. Only the fields you include change; omitted fields keep their current value. To re-parent a folder, use PUT /v1/external/folders/{folderId}/move — PATCH cannot change the parent.

​
title
string

New folder title. Must not be blank.

Required string length: 1 - 50
Example:

"Engineering Sync"

​
sharingType
enum<string>

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"

​
description
string | null

New folder description

Example:

"Daily standup notes"

​
color
string | null

New folder color in hex format (#RRGGBB)

Pattern: ^#[0-9A-Fa-f]{6}$
Example:

"#E74C3C"

Response

Folder updated

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"