Skip to content
REST API

Update a note folder

PATCH
/note-folders/{folderId}

Changes only the fields you send; null on subjectId unfiles the folder. Renaming to a name another of the user's folders already has is refused, as when creating one.

Required scopes: notes:update

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

folderId*string

Note folder id, scoped to the key's user.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Send only the fields to change. An omitted field stays as it is.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/note-folders/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",    "name": "Biology",    "subjectId": null,    "icon": "Folder"  }}