API Reference
Dev Portal

createGroup

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

Use the createGroup command in the groups namespace to create a new group from a list
of players. The player returns a group object with the group ID. This may be an existing
group ID if an existing group is a subset of the new group. In this case, Sonos may
build the new group by adding new players to the existing group.

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

Target householdId

Body Params
playerIds
array of strings
required
length ≤ 32

An array of player ID strings to group.

playerIds*
string | null

(Optional) The group containing the audio that you want to use. If empty or not provided,
the new group will not contain any audio.

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 23 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 23 days ago