Documentation

AddMembers

Adds members to a group or role.

Request Details

Adds members to a group or role. Existing members of the group will added to roles within the group, but if the user is not already a member of the group, only title claimants may add them to the group, and others must use the group application or invite system to add new members to a group. Returns nothing if successful.

AddMembersRequest
Request Properties
Group (required) EntityKey

The identifier of the group

Members (required) List<EntityKey>

List of entities to add to the group. Only entities of type title_player_account and character may be added to groups.

RoleId String

Optional: The ID of the existing role to add the entities to. If this is not specified, the default member role for the group will be used. Role IDs must be between 1 and 64 characters long.

POST https://{{TitleID}}.playfabapi.com/Group/AddMembers
    Content-Type: application/json
{
  "Group": {
    "Id": "ABC1234ABC"
  },
  "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