---
title: "setMute"
method: POST
path: "/players/{playerId}/playerVolume/mute"
tags: ["playerVolume"]
---

# setMute

`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`

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.

## Request body

- object
  - `muted` boolean, required: true to mute the player or false to unmute the player.

## Response `200`

See the x-muse-error-codes extension for a list of muse errors that generate this response

- Ok: This object represents an empty (default) success. The platform returns an empty object ({}).

## Other responses

- `400`: See the x-muse-error-codes extension for a list of muse errors that generate this response
- `401`: See the x-muse-error-codes extension for a list of muse errors that generate this response
- `403`: See the x-muse-error-codes extension for a list of muse errors that generate this response
- `404`: See the x-muse-error-codes extension for a list of muse errors that generate this response
- `499`: See the x-muse-error-codes extension for a list of muse errors that generate this response
- `500`: See the x-muse-error-codes extension for a list of muse errors that generate this response
- `503`: See the x-muse-error-codes extension for a list of muse errors that generate this response

---

[API](https://skmtc.dev/sonos/apis/sonos-control-api-cloud.md) - [All operations](https://skmtc.dev/sonos/apis/sonos-control-api-cloud/llms.txt) - [OpenAPI document](https://skmtc.dev/sonos/apis/sonos-control-api-cloud/revisions/0c452bcf7b2a?raw)