Shared Group Data - Remove Shared Group Members
Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
POST https://titleId.playfabapi.com/Client/RemoveSharedGroupMembersRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-Authorization | True |
string |
This API requires a client session ticket, available from any Client Login function. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| PlayFabIds | True |
string[] |
An array of unique PlayFab assigned ID of the user on whom the operation will be performed. |
| SharedGroupId | True |
string |
Unique identifier for the shared group. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-Authorization
This API requires a client session ticket, available from any Client Login function.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Remove |
|
|
Remove |
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 |
RemoveSharedGroupMembersRequest
| Name | Type | Description |
|---|---|---|
| PlayFabIds |
string[] |
An array of unique PlayFab assigned ID of the user on whom the operation will be performed. |
| SharedGroupId |
string |
Unique identifier for the shared group. |