Documentation

CreateSharedGroup

Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. When created by a server, the group will initially have no members. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://api.playfab.com/docs/tutorials/landing-players/shared-groups

Request Details

If SharedGroupId is specified, the service will attempt to create a group with that identifier, and will return an error if it is already in use. If no SharedGroupId is specified, a random identifier will be assigned.

CreateSharedGroupRequest
Request Properties
SharedGroupId String

Unique identifier for the shared group (a random identifier will be assigned, if one is not specified).

POST https://{{TitleID}}.playfabapi.com/Server/CreateSharedGroup
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "SharedGroupId": "Clan Data"
}
        

Response Details

CreateSharedGroupResult
Result Properties
SharedGroupId String

Unique identifier for the shared group.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "SharedGroupId": "Clan Data"
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
InvalidSharedGroupId 1088