Account Management - Unlink Server Custom Id

  • Reference
Service:
Server
API Version:
240412

Unlinks the custom server identifier from the user's PlayFab account.

POST https://titleId.playfabapi.com/Server/UnlinkServerCustomId

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

string

Unique PlayFab identifier.
ServerCustomId True

string

Unique server custom identifier for this player.
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name Type Description
200 OK

UnlinkServerCustomIdResult

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
UnlinkServerCustomIdRequest
UnlinkServerCustomIdResult

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

UnlinkServerCustomIdRequest

Name Type Description
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
PlayFabId

string

Unique PlayFab identifier.
ServerCustomId

string

Unique server custom identifier for this player.

UnlinkServerCustomIdResult

Error Codes

Name Code
AccountNotLinked 1014
IdentifierNotLinked 1239