Documentation

ChangeMemberRole

Changes the role membership of a list of entities from one role to another.

Request Details

Changes the role membership of a list of entities from one role to another in in a single operation. The destination role must already exist. This is equivalent to adding the entities to the destination role and removing from the origin role. Returns nothing if successful.

ChangeMemberRoleRequest
Request Properties
DestinationRoleId String

The ID of the role that the entities will become a member of. This must be an existing role. Role IDs must be between 1 and 64 characters long.

Group (required) EntityKey

The identifier of the group

Members (required) List<EntityKey>

List of entities to move between roles in the group. All entities in this list must be members of the group and origin role.

OriginRoleId (required) String

The ID of the role that the entities currently are a member of. Role IDs must be between 1 and 64 characters long.

POST https://{{TitleID}}.playfabapi.com/Group/ChangeMemberRole
    Content-Type: application/json
{
  "Group": {
    "Id": "ABC1234ABC"
  },
  "OriginRoleId": "awesomepeople",
  "DestinationRoleId": "members",
  "Members": [
    {
      "Id": "90901000",
      "Type": "title_player_account",
      "TypeString": "title_player_account"
    }
  ]
}
        

Response Details

EmptyResponse
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

EntityToken

Possible Error Codes

Name Code
InvalidParams 1000
NotAuthenticated 1074
NotAuthorized 1089
RoleDoesNotExist 1358