Account Management - Link Xbox Account

Links the Xbox Live account associated with the provided access code to the user's PlayFab account

POST https://titleId.playfabapi.com/Client/LinkXboxAccount

Request Body

Name Required Type Description
ForceLink
  • boolean

If another user is already linked to the account, unlink the other user and re-link.

XboxToken True
  • string

Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", "").

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

SessionTicket

This API requires a client session ticket, available from any Client Login function.

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

LinkXboxAccountRequest
LinkXboxAccountResult

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

LinkXboxAccountRequest

Name Type Description
ForceLink
  • boolean

If another user is already linked to the account, unlink the other user and re-link.

XboxToken
  • string

Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", "").

LinkXboxAccountResult

Error Codes

Name Code
AccountAlreadyLinked 1011
ExpiredXboxLiveToken 1189
InvalidXboxLiveToken 1188
LinkedAccountAlreadyClaimed 1012