Groups - Remove Members

Service:

Groups

API Version:

240412

Removes members from a group.

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

Request Header

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

Request Body

Name	Required	Type	Description
Group	True	EntityKey	The identifier of the group
Members	True	EntityKey[]	List of entities to remove
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 remove the entities from.

Responses

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

Security

X-EntityToken

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

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
EmptyResponse
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
RemoveMembersRequest	Removes members from a group. A member can always remove themselves from a group, regardless of permissions. Returns nothing if successful.

ApiErrorWrapper

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

EmptyResponse

EntityKey

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

RemoveMembersRequest

Removes members from a group. A member can always remove themselves from a group, regardless of permissions. Returns nothing if successful.

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
Members	EntityKey[]	List of entities to remove
RoleId	string	The ID of the role to remove the entities from.

Error Codes

Name	Code
RoleDoesNotExist	1358