Documentation

BlockEntity

Blocks a list of entities from joining a group.

Request Details

Blocks a list of entities from joining a group. Blocked entities may not create new applications to join, be invited to join, accept an invitation, or have an application accepted. Failure due to being blocked does not clean up existing applications or invitations to the group. No data is returned in the case of success.

BlockEntityRequest
Request Properties
Entity (required) EntityKey

The entity to perform this action on.

Group (required) EntityKey

The identifier of the group

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