Class ChangePlaylistDetailsRequest


  • public class ChangePlaylistDetailsRequest
    extends Object
    Change a Playlist's Details request

    Required OAuth scopes

    playlist-modify-public, playlist-modify-private

    Response

    On success the HTTP status code in the response header is 200 OK.

    On error, the header status code is an error code and the response body contains an error object. Trying to change a playlist when you do not have the user's authorization returns error 403 Forbidden.

    • Constructor Detail

      • ChangePlaylistDetailsRequest

        public ChangePlaylistDetailsRequest​(ApiClient apiClient,
                                            String playlistId)

        Change a Playlist's Details request

        Parameters:
        apiClient -

        The API client

        playlistId -

        The Spotify ID for the playlist.

    • Method Detail

      • _public

        public ChangePlaylistDetailsRequest _public​(boolean _public)

        If true the playlist will be public, if false it will be private.

      • collaborative

        public ChangePlaylistDetailsRequest collaborative​(boolean collaborative)

        If true , the playlist will become collaborative and other users will be able to modify the playlist in their Spotify client. Note: You can only set collaborative to true on non-public playlists.

      • description

        public ChangePlaylistDetailsRequest description​(String description)

        Value for playlist description as displayed in Spotify Clients and in the Web API.

      • build

        public ApiCall<Void> build()
        Build the request into an executable call