Sign in

v1

latestOpenAPI 3.1.02026-07-246652306.5 KB
groups

setGroupMembers

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

post/groups/{groupId}/groups/setGroupMembers

Request body

playerIdsstring[] nullable

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

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