folder

Edit Folder

Changed on

Edit existing Folder

put/folders/{folderId}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/folders/{folderId}
  • Auth
    none declared

Path parameters

folderIdinteger required

Folder ID to edit

Request body application/x-www-form-urlencoded

textstring required

Folder Name

Response

successful operation

idinteger

The ID of this Folder

typestring

The type of folder (home or root)

textstring

The name of this Folder

parentIdinteger

The folderId of the parent of this Folder

isRootinteger

Flag indicating whether this is root Folder

childrenstring

An array of children folderIds

createdDtstring nullable

Date this Folder was created

modifiedDtstring nullable

Date this Folder was last modified

Changes

  • fe497e811c7fRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 41c04de98ec5Revision changes
    • breaking

      added required request body

    • info

      added the media type application/json for the response with the status