API Reference
Dev Portal

loadPlaylist

post
{protocol}://api.ws.sonos.com/control/api/{version}/groups//playlists

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Target groupId

Body Params
string
required
length ≤ 36

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

string
enum

(Optional) Controls how the the player inserts the playlist into the shared queue, such as APPEND, INSERT, INSERT_NEXT, or REPLACE. If omitted, defaults to append.

Allowed:
playModes
object

(Optional) Defines the functionality of one or more play modes. You can set these to customize shuffle, repeat, repeat-one and crossfade.

boolean | null

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

Headers
uuid
deprecated

Client API Key for the integration. Required in V1 but deprecated in V2.

uuid

Correlation UUID for data tracking purposes

Responses

Updated 27 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 27 days ago