Documentation

DeleteGroup

Deletes a group and all roles, invitations, join requests, and blocks associated with it.

Request Details

Deletes a group and all roles, invitations, join requests, and blocks associated with it. Permission to delete is only required the group itself to execute this action. The group and data cannot be cannot be recovered once removed, but any abuse reports about the group will remain. No data is returned in the case of success.

DeleteGroupRequest
Request Properties
Group (required) EntityKey

ID of the group or role to remove

POST https://{{TitleID}}.playfabapi.com/Group/DeleteGroup
    Content-Type: application/json
{
  "Group": {
    "Id": "ABC1234ABC"
  }
}
        

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