Update Group
Updates non-membership data about a group.
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| GroupNameNotAvailable | 1368 |
| RoleDoesNotExist | 1358 |
Authorizations
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Body
Updates data about a group, such as the name or default member role. Returns information about whether the update was successful. Only title claimants may modify the administration role for a group.
Updates data about a group, such as the name or default member role. Returns information about whether the update was successful. Only title claimants may modify the administration role for a group.
The identifier of the group
Optional: the ID of an existing role to set as the new administrator role for the group
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Optional field used for concurrency control. By specifying the previously returned ProfileVersion value from the GetGroup API, you can ensure that the group data update is performed only if the group has not been updated since you last loaded that version. If the same group has been updated, the requested update will not occur and the returned SetResult value will be None.
Optional: the new name of the group
Optional: the ID of an existing role to set as the new member role for the group
