Eagle API Document
  • Overview
  • Application
    • /api/application/info
  • Folder
    • /api/folder/create
    • /api/folder/rename
    • /api/folder/update
    • /api/folder/list
    • /api/folder/listRecent
  • Item
    • /api/item/addFromURL
    • /api/item/addFromURLs
    • /api/item/addFromPath
    • /api/item/addFromPaths
    • /api/item/addBookmark
    • /api/item/info
    • /api/item/thumbnail
    • /api/item/list
    • /api/item/moveToTrash
    • /api/item/refreshPalette
    • /api/item/refreshThumbnail
    • /api/item/update
  • Library
    • /api/library/info
    • /api/library/history
    • /api/library/switch
    • /api/library/icon
  • Examples
    • Using Eagle API with Tampermonkey
  • Changelog
Powered by GitBook
On this page

Was this helpful?

  1. Folder

/api/folder/update

POST Update the specified folder.

Parameter

Description

folderId

The folder's ID

newName

The new name of the folder

newDescription

The new description of the folder

newColor

"red","orange","green","yellow","aqua","blue","purple","pink"

Sample Code:

var data = {
    "folderId": "KMUFMKTBHINM4",
    "newName": "New Name",
    "newDescription": "New Description",
    "newColor": "red"
};

var requestOptions = {
  method: 'POST',
  body: JSON.stringify(data),
  redirect: 'follow'
};

fetch("http://localhost:41595/api/folder/update", requestOptions)
  .then(response => response.json())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Results Returned:

{
    "status": "success",
    "data": {
        "id": "KMUFMKTBHINM4",
        "name": "New Name",
        "description": "New Description",
        "images": [],
        "folders": [],
        "modificationTime": 1592409993367,
        "imagesMappings": {},
        "tags": [],
        "children": [],
        "isExpand": true,
        "size": 30,
        "vstype": "folder",
        "styles": {
            "depth": 0,
            "first": false,
            "last": false
        },
        "isVisible": true,
        "$$hashKey": "object:765",
        "editable": false,
    }
}
Previous/api/folder/renameNext/api/folder/list

Last updated 4 years ago

Was this helpful?