Documentation

UpdateGroup

Updates non-membership data about a group.

Request Details

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.

UpdateGroupRequest
Request Properties
AdminRoleId String

Optional: the ID of an existing role to set as the new administrator role for the group

ExpectedProfileVersion int32

Optional field used for concurrency control. By specifying the previously returned value of ProfileVersion from the GetGroup API, you can ensure that the group data update will only be performed if the group has not been updated by any other clients since the version you last loaded.

Group (required) EntityKey

The identifier of the group

GroupName String

Optional: the new name of the group

MemberRoleId String

Optional: the ID of an existing role to set as the new member role for the group

POST https://{{TitleID}}.playfabapi.com/Group/UpdateGroup
    Content-Type: application/json
{
  "Group": {
    "Id": "ABC1234ABC"
  },
  "GroupName": "My New Group Name",
  "ExpectedProfileVersion": 17
}
        

Response Details

UpdateGroupResponse
Result Properties
OperationReason String

Optional reason to explain why the operation was the result that it was.

ProfileVersion (required) int32

New version of the group data.

SetResult OperationTypes

Indicates which operation was completed, either Created, Updated, Deleted or None.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "ProfileVersion": 18,
    "SetResult": "Updated"
  }
}

Authentication

EntityToken

Possible Error Codes

Name Code
NotAuthenticated 1074
NotAuthorized 1089
RoleDoesNotExist 1358