---
title: "pause"
method: POST
path: "/groups/{groupId}/playback/pause"
tags: ["playback"]
---

# pause

`POST /groups/{groupId}/playback/pause`

## Request

- Base URL: `https://api.ws.sonos.com/control/api/v1`
- URL: `https://api.ws.sonos.com/control/api/v1/groups/{groupId}/playback/pause`
- 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 pause command in the playback namespace to pause group playback.

 After a successful pause command, if your app is subscribed to the playback namespace, it will receive a playbackStatus event with either PLAYBACK_STATE_PAUSED or PLAYBACK_STATE_IDLE, depending on the audio source loaded on the group.

## 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`: 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`: 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)