v1

latestOpenAPI 3.1.02026-07-246652306.5 KB

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.

post/households/{householdId}/groups/createGroup

Request body

playerIdsstring[] required

An array of player ID strings to group.

musicContextGroupIdstring nullable

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

areaIdsstring[] nullable

(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.

Response

Returns a groupInfo object, which currently only includes a group object. The groupInfo object may include additional information in the future.

Muse v2 sends playerSetError which includes playerIds array since version 1.17.0