AMampache
Playlist Folders

Edit a playlist folder

Changed on

Renames, re-parents, repositions or (un)hides a folder. Anything not sent is left alone. Moving a folder into its own subtree is refused, because it would detach the branch from the tree. hidden is the one field a caller may also set on a folder they do not own.

patch/playlist-folders/{playlist_folder_id}

Request

  • Base URL
    https://develop.ampache.dev/rest/8/json
  • URL
    https://develop.ampache.dev/rest/8/json/playlist-folders/{playlist_folder_id}
  • Auth
    • HTTP bearer
    • or API key in header auth
    • or API key in query parameter auth

Path parameters

playlist_folder_idstring required

The folder, as a numeric id or a name path such as /Rock/Live

Query parameters

namestring
parentstring

New parent as an id or a name path; 0 for the root

sort_orderinteger
type'private' | 'public'

Public requires Content Manager access (level 50)

hiddenboolean

True to mark the folder hidden in the caller's own root, false to unhide. The one field a caller may set on a folder they do not own

Request body

namestring
parentstring

New parent as an id or a name path; 0 for the root

sort_orderinteger
type'private' | 'public'

Public requires Content Manager access (level 50)

hiddenboolean

True to mark the folder hidden in the caller's own root, false to unhide. The one field a caller may set on a folder they do not own

Response

The folder that was updated

total_countinteger required
md5string required

Changes

  • 093078830137Revision changes
    • info

      added the new optional query request parameter hidden

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

  • a016cef1ebc1Revision changes
    • info

      added the new optional query request parameter type

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status