patch/api/v1/folders/{folderId}

Request

  • Base URL: https://falconer.com (the document declares no server; this is the origin it was published from)
  • URL: https://falconer.com/api/v1/folders/{folderId}
  • Auth: none declared

Path parameters

folderIdinteger required

Headers

x-organization-idstring

Required when using OAuth bearer tokens.

Request body

titlestring
descriptionstring nullable

Response

Folder updated

type'folder' | 'document' | 'file' required
navItemIdnumber required
parentFolderIdnumber nullable required

Parent folder or document nav item ID; null at the section root.

titlestring required
iconstring nullable required
ordernumber required
section'company' | 'private' required

Where the document landed. Without a parent it lands in your private section.

folderIdnumber
descriptionstring nullable
childCountnumber

Visible direct children of a folder or document.

childrenLoadedboolean

Whether all visible direct children have been loaded.

childrenNavItem[] circular

Changes

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