Shared Group Data - Add Shared Group Members

Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group (and the server) can add new members. 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/AddSharedGroupMembers

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

AddSharedGroupMembersResult

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
AddSharedGroupMembersRequest
AddSharedGroupMembersResult
ApiErrorWrapper

The basic wrapper around every failed API response

AddSharedGroupMembersRequest

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.

AddSharedGroupMembersResult

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

Error Codes

Name Code
InvalidSharedGroupId 1088
UserAlreadyAdded 1235