favorites > subscribe

Use this command to subscribe to events in the favorites namespace.

When subscribed, Sonos sends asynchronous versionChanged events when users update their Sonos favorites. Your app can then choose to fetch the favorites as needed whenever the version changes. This is because the FavoritesList object can be large for asynchronous events.



Request parameters

There are no request parameters in the body, all of the request parameters are in the header.

This command requires a householdId to determine the household for which to display grouping information. See the Control documentation for details.


Returns an empty body with a success value of true if successful.

In the event of a failure, returns a globalError.

versionChanged object

The versionChanged object consists of a version field, described below.

Parameter Type Value
version string The new version string. Sonos updates this version whenever the Sonos favorites change for the household. Your app can then send a getFavorites command to receive the new list of favorites.