API Reference
Dev Portal

setGroupMembers

post
{protocol}://api.ws.sonos.com/control/api/{version}/groups//groups/setGroupMembers

Use the setGroupMembers command in the groups namespace to replace the players in an
existing group with a new set.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Target groupId

Body Params
playerIds
array of strings | null

An array of player ID strings corresponding to the new set of players for the group.

playerIds
areaIds
array of strings | null

(Optional) List of source areaIds in the group. Emitted in groupInfo events. As of
version 1.19.1, this can include the "Everywhere" area ID. If it does, this indicates
that the group includes all visible players.

areaIds
Headers
uuid
deprecated

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

uuid

Correlation UUID for data tracking purposes

Responses

Updated 27 days ago

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

Updated 27 days ago