v1

latestOpenAPI 3.1.02026-07-246652306.5 KB

playlists

loadPlaylist

The loadPlaylist command activates a playlist within the default playback session. This command interrupts any active private playback sessions. Sonos adds tracks from the playlist to the queue and activates the queue. This prevents your app from overwriting user-curated queues.

post/groups/{groupId}/playlists

Request body

playlistIdstring required

The identifier of the playlist. You can find this in the playlistsList object in the getPlaylists response.

action'REPLACE' | 'APPEND' | 'INSERT' | 'INSERT_NEXT' | 'PLAY_NOW'

No description available

playOnCompletionboolean nullable

(Optional) If true, the player automatically starts playback. If false or not provided, the player remains in the PLAYBACK_IDLE state.

Response

See the x-muse-error-codes extension for a list of muse errors that generate this response

Ok required

This object represents an empty (default) success. The platform returns an empty object ({}).