Playlists

Add an item to a playlist

Changed on

This adds a song to a playlist. setting check=1 will not add duplicates to the playlist

post/playlists/{playlist_id}/add

Request

  • Base URL
    https://develop.ampache.dev/rest/8/json
  • URL
    https://develop.ampache.dev/rest/8/json/playlists/{playlist_id}/add
  • 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

UID of the object to add to playlist

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

Default: song

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

DEPRECATED, use object_type instead. Will be removed in API9

Request body

idstring required

UID of the object to add to playlist

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

Default: song

type'song' | 'album' | 'artist' | 'playlist' required

DEPRECATED, use object_type instead. Will be removed in API9

Response

Success

successstring

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

    • info

      api operation id playlistAdd was added

    • info

      added optional request body

    • info

      the query request parameter id became optional

    • info

      the query request parameter type became optional

    • 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