API Reference
Dev Portal

loadFavorite

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

The loadFavorite command in the favorites namespace activates a favorite within the default playback session. This command interrupts any active private playback sessions. Sonos adds album, tracklist, and track favorites 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 favorite. You can find this in the favoriteList object in the getFavorites response.

string
enum

(Optional) Controls how the the player inserts the favorite into the shared queue, such as APPEND, INSERT, INSERT_NEXT, or REPLACE. Not used when the favorite is a radio station (programmed or streamed). 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. The player ignores this parameter when the loaded favorite does not allow custom play modes, such as for streaming radio stations.

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