v1

latestOpenAPI 3.1.02026-07-17186070.1 KB

Rename and/or move a folder

Provide name, parent, or both. Fields left out (or null) are unchanged. An explicit parent that doesn't exist in the notebook, or that would move the folder into its own subtree, is rejected.

put/notes/~/v1/notebooks/{host}/{name}/folders/{id}

Path parameters

hoststring required

namestring required

idinteger required

Request body

folderNamestring nullable

parentinteger nullable

Response

Updated — response carries the folder-updated update

requestIdstring required

Canonical Hoon @uv (base-32 with . separators every 5 chars from the right, prefixed 0v). A correlation id for the request. OPTIONAL on POST: if you omit it (or send something that isn't a valid @uv), the server mints one and returns it in the response. You only need to supply your own if you intend to poll GET /request/{requestId} or subscribe to the SSE request stream — for the common case (read the held-open POST response inline) you can leave it out entirely.

Example response

{
  "requestId": "0v3.1k7gh.j5b2m.r8nq9",
  "body": {
    "response": {
      "host": "~zod",
      "flagName": "my-notebook-1"
    }
  }
}