User Folders

Update a folder in the current user's workspace

patch/folders/{folderId}

Request

  • Base URL: https://api.hackmd.io/v1
  • URL: https://api.hackmd.io/v1/folders/{folderId}
  • Auth: HTTP bearer

Path parameters

folderIdstring required

The ID of the folder to update.

Request body

parentFolderIdstring nullable
colorstring

Folder display color in hexadecimal format. Accepts #RGB, #RGBA, #RRGGBB, or #RRGGBBAA.

iconstring

Folder icon as an emoji unified codepoint string. Examples: 1F525 (🔥), 2764-FE0F (❤️).

descriptionstring nullable
namestring

Folder name.

Example request

{
  "color": "#FF6B6B",
  "icon": "1F525",
  "name": "Engineering"
}

Changes

No recorded changes to this operation across all 1 revision of this API.