Groups - Remove Members
Removes members from a group.
POST https://titleId.playfabapi.com/Group/RemoveMembers
Request Header
Name | Required | Type | Description |
---|---|---|---|
X-EntityToken | True |
|
This API requires an Entity Session Token, available from the Entity GetEntityToken method. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
Group | True |
The identifier of the group |
|
Members | True |
List of entities to remove |
|
CustomTags |
|
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
|
RoleId |
|
The ID of the role to remove the entities from. |
Responses
Name | Type | Description |
---|---|---|
200 OK | ||
400 Bad Request |
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
Api |
The basic wrapper around every failed API response |
Empty |
|
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
Remove |
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 |
|
Numerical HTTP code |
error |
|
Playfab error code |
errorCode |
|
Numerical PlayFab error code |
errorDetails |
|
Detailed description of individual issues with the request object |
errorMessage |
|
Description for the PlayFab errorCode |
status |
|
String HTTP code |
EmptyResponse
EntityKey
Combined entity type and ID structure which uniquely identifies a single entity.
Name | Type | Description |
---|---|---|
Id |
|
Unique ID of the entity. |
Type |
|
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 |
|
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
Group |
The identifier of the group |
|
Members |
List of entities to remove |
|
RoleId |
|
The ID of the role to remove the entities from. |
Error Codes
Name | Code |
---|---|
RoleDoesNotExist | 1358 |