Skip to content
DocumentationAPI Reference

Change Playlist Details

playlists().update(PlaylistUpdateParamsparams = PlaylistUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
PUT/playlists/{playlist_id}

Change a playlist's name and public/private state. (The user must, of course, own the playlist.)

ParametersExpand Collapse
params: PlaylistUpdateParams
playlistId: Optional<String>

The Spotify ID of the playlist.

collaborative: Optional<Boolean>

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: Optional<String>

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

name: Optional<String>

The new name for the playlist, for example "My New Playlist Title"

published: Optional<Boolean>

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

Change Playlist Details

package dev.cjav.spotted.example

import dev.cjav.spotted.client.SpottedClient
import dev.cjav.spotted.client.okhttp.SpottedOkHttpClient
import dev.cjav.spotted.models.playlists.PlaylistUpdateParams

fun main() {
    val client: SpottedClient = SpottedOkHttpClient.fromEnv()

    client.playlists().update("3cEYpjA9oz9GiPac4AsH4n")
}
Returns Examples