SOsonos
playerVolume

setMute

Use the setMute command in the playerVolume namespace to mute and unmute a player.

Returns an empty body with a success value of true if successful. The player generates a playerVolume event if the mute state was changed.

post/players/{playerId}/playerVolume/mute

Request

  • Base URL
    https://api.ws.sonos.com/control/api/v1
  • URL
    https://api.ws.sonos.com/control/api/v1/players/{playerId}/playerVolume/mute
  • Auth
    OAuth 2 and HTTP bearer and API key in header X-Sonos-Api-Key
    Authorization code: https://api.sonos.com/login/v3/oauth
    Token URL: https://api.sonos.com/login/v3/oauth/access scopes: playback-control-all

Request body

mutedboolean required

true to mute the player or false to unmute the player.

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 ({}).

Changes

No recorded changes to this operation across all 1 revision of this API.