User Folders

Create a new folder in the current user's workspace

post/folders

Request

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

Request body

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
parentFolderIdstring
namestring

Folder name.

Example request

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

Response

idstring required
namestring required

Folder name.

descriptionstring nullable required
iconstring required

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

colorstring required

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

parentFolderIdstring nullable required
createdAtnumber double required
updatedAtnumber double required

Example response

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

Changes

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