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

# duck

`POST /players/{playerId}/playerVolume/duck`

## Request

- Base URL: `https://api.ws.sonos.com/control/api/v1`
- URL: `https://api.ws.sonos.com/control/api/v1/players/{playerId}/playerVolume/duck`
- 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`

Ducking temporarily lowers the zone's volume without affecting the observed system volume. Sending another "duck" command to a system that is already ducking does not affect the output level. However, it does reset the duration.

## Request body

- object
  - `durationMillis` integer, nullable: Ducking lasts for the specified time, unless explicitly ended with the "unduck" command. The default value is 3 seconds when this value is omitted. The minimum value is 0 seconds. The maximum value is 60 seconds. Values outside the valid range are clamped.

## 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`: The given resource/object identifier is invalid
- `401`: A client has not provided authorization credentials to perform a command
- `403`: A client does not have the correct permissions to perform a command
- `404`: A command was targeted to a group that no longer is the same group
- `499`: Indicates there was an error occurred when performing a command
- `500`: Sonos has experience an unexpected condition it is unable to recover from
- `503`: Player is unable to reach the service.

---

[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)