Documentation

RemoveMembers

Removes members from a group.

Request Details

Removes members from a group. A member can always remove themselves from a group, regardless of permissions. Returns nothing if successful.

RemoveMembersRequest
Request Properties
Group (required) EntityKey

The identifier of the group

Members (required) List<EntityKey>

List of entities to remove

RoleId String

The ID of the role to remove the entities from.

POST https://{{TitleID}}.playfabapi.com/Group/RemoveMembers
    Content-Type: application/json
{
  "Group": {
    "Id": "ABC1234ABC"
  },
  "RoleId": "ABC1234DEF",
  "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
NotAuthenticated 1074
NotAuthorized 1089