Skip to content
Spotted Docs Spotted Docs
DocumentationAPI Reference
API Reference
Me
Player

Toggle Playback Shuffle

me().player().toggleShuffle(PlayerToggleShuffleParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
PUT/me/player/shuffle

Toggle shuffle on or off for user’s playback. This API only works for users who have Spotify Premium. The order of execution is not guaranteed when you use this API with other Player API endpoints.

ParametersExpand Collapse
params: PlayerToggleShuffleParams
state: Boolean

true : Shuffle user's playback.
false : Do not shuffle user's playback.

deviceId: Optional<String>

The id of the device this command is targeting. If not supplied, the user's currently active device is the target.

Toggle Playback Shuffle 

package dev.cjav.spotted.example

import dev.cjav.spotted.client.SpottedClient
import dev.cjav.spotted.client.okhttp.SpottedOkHttpClient
import dev.cjav.spotted.models.me.player.PlayerToggleShuffleParams

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

    val params: PlayerToggleShuffleParams = PlayerToggleShuffleParams.builder()
        .state(true)
        .build()
    client.me().player().toggleShuffle(params)
}
Returns Examples