Documentation

DeleteRole

Deletes an existing role in a group.

Request Details

Returns information about the role

DeleteRoleRequest
Request Properties
Group (required) EntityKey

The identifier of the group

RoleId String

The ID of the role to delete. Role IDs must be between 1 and 64 characters long.

POST https://{{TitleID}}.playfabapi.com/Group/DeleteRole
    Content-Type: application/json
{
  "Group": {
    "Id": "ABC1234ABC"
  },
  "RoleId": "ABC1234DEF"
}
        

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
RoleDoesNotExist 1358