Account Management - Unlink Xbox Account

  • Reference
Service:
Server
API Version:
240412

Unlinks the related Xbox Live account from the user's PlayFab account

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

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 for a user, or null if no PlayFab account is linked to the Xbox Live identifier.
CustomTags

object

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

Responses

Name Type Description
200 OK

UnlinkXboxAccountResult

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
UnlinkXboxAccountRequest
UnlinkXboxAccountResult

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

UnlinkXboxAccountRequest

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 for a user, or null if no PlayFab account is linked to the Xbox Live identifier.

UnlinkXboxAccountResult

Error Codes

Name Code
AccountNotLinked 1014
InvalidXboxLiveToken 1188