Shared Group Data - Delete Shared Group

  • Reference
Service:
Server
API Version:
240412

Deletes a shared group, freeing up the shared group ID to be reused for a new group. 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/DeleteSharedGroup

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
SharedGroupId True

string

Unique identifier for the shared group.

Responses

Name Type Description
200 OK

EmptyResponse

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
DeleteSharedGroupRequest
EmptyResponse

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

DeleteSharedGroupRequest

Name Type Description
SharedGroupId

string

Unique identifier for the shared group.

EmptyResponse

Error Codes

Name Code
InvalidSharedGroupId 1088