Groups - Delete Role

Deletes an existing role in a group.

POST https://titleId.playfabapi.com/Group/DeleteRole

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Name	Required	Type	Description
Group	True	EntityKey	The identifier of the group
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
RoleId		string	The ID of the role to delete. Role IDs must be between 1 and 64 characters long.

Name	Type	Description
200 OK	EmptyResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
DeleteRoleRequest	Returns information about the role
EmptyResponse
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

Returns information about the role

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Group	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.

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types