playlists > subscribe

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

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



Request parameters

This command requires a householdId to determine the household for which to display playlist 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 playlists change for the household. Your app can then send a getPlaylists command to receive the new list of playlists.