setPlayModes

Use the setPlayModes command in the playback namespace to change group play modes, such as repeat, repeat one track, shuffle, and crossfade. See Play Modes for details.

Configure a play mode in the playModes array by adding a “true” or “false” value for the mode, or omit a play mode to leave it unchanged.

Path Params
string
required

Target groupId

Body Params
playModes
object
required

An array of play modes that define the functionality of one or more play modes: repeat, repeatOne, shuffle, and crossfade. Any omitted play modes remain unchanged. See the playMode type for details.

Headers
uuid
deprecated

Client API Key for the integration. Required in V1 but deprecated in V2.

uuid

Correlation UUID for data tracking purposes

Responses
200

Request was successful.

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

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.

Language
Credentials
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json