Shared Group Data - Remove Shared Group Members

Service:

Server

API Version:

241122

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/Server/RemoveSharedGroupMembers

Request Header

Name	Required	Type	Description
X-SecretKey	True	string	This API requires a title secret key, available to title admins, from PlayFab Game Manager.

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	RemoveSharedGroupMembersResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
RemoveSharedGroupMembersRequest
RemoveSharedGroupMembersResult

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.

RemoveSharedGroupMembersResult

Error Codes

Name	Code
InvalidSharedGroupId	1088