AMampache
Playlists

Remove an object (by id and type, or track number, or clear) from a playlist

Changed on

Remove objects from a playlist using track number in the list or object id and type. Using clear will empty the entire list.

post/playlists/{playlist_id}/remove

Request

  • Base URL
    https://develop.ampache.dev/rest/8/json
  • URL
    https://develop.ampache.dev/rest/8/json/playlists/{playlist_id}/remove
  • Auth
    • HTTP bearer
    • or API key in header auth
    • or API key in query parameter auth

Path parameters

playlist_idstring required

Unique identifier of the playlist.

Query parameters

idstring

Object id

object_type'song' | 'album' | 'artist' | 'playlist'
type'song' | 'album' | 'artist' | 'playlist'

DEPRECATED, use object_type instead. Will be removed in API9

trackstring

Track number to remove from the playlist

clear0 | 1

Clear the whole playlist

Request body

idstring

Object id

object_type'song' | 'album' | 'artist' | 'playlist'
type'song' | 'album' | 'artist' | 'playlist'

DEPRECATED, use object_type instead. Will be removed in API9

trackstring

Track number to remove from the playlist

clear0 | 1

Clear the whole playlist

Response

Success

successstring

Changes

  • 42d304fb6867Revision changes
    • info

      added the new optional query request parameter object_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

      query request parameter type was deprecated

  • e8e6b266ea29Revision changes
    • info

      api operation id playlistRemove was added

    • info

      added optional request body

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status