v1

latestOpenAPI 3.0.0Superhuman Developer Terms2026-08-06124404444.0 KB
Folders

Update folder

Updates metadata for a folder.

patch/folders/{folderId}

Path parameters

folderIdstring required

ID of the folder.

Request body

namestring

Name of the folder.

descriptionstring

Description of the folder.

Example request

{
  "name": "Projects",
  "description": "A collection of project docs."
}

Response

The updated folder.

idstring required

ID of the Superhuman Docs folder.

type'folder' required

The type of this resource.

namestring required

The name of the folder.

browserLinkstring url required

Browser-friendly link to the folder.

descriptionstring

The description of the folder.

createdAtstring date-time

Timestamp for when the folder was created.

canEditboolean

Whether the folder settings can be edited. E.g., some folder types (like personal folders - "My Docs") cannot be edited.

Example response

{
  "id": "fl-1Ab234",
  "name": "Projects",
  "browserLink": "https://docs.superhuman.com/folders/fl-1Ab234",
  "description": "A collection of project docs.",
  "icon": {
    "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"
  },
  "createdAt": "2018-04-11T00:18:57.946Z",
  "canEdit": true,
  "workspace": {
    "id": "ws-1Ab234",
    "organizationId": "org-2Bc456",
    "browserLink": "https://docs.superhuman.com/docs?workspaceId=ws-1Ab234",
    "name": "My workspace"
  }
}