Account Management - Link Twitch

Links the Twitch account associated with the token to the user's PlayFab account.

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

Request Header

Name Required Type Description
X-Authorization True
  • string

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

Request Body

Name Required Type Description
AccessToken True
  • string

Valid token issued by Twitch

CustomTags
  • object

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

ForceLink
  • boolean

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

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

X-Authorization

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

LinkTwitchAccountRequest
LinkTwitchAccountResult

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

LinkTwitchAccountRequest

Name Type Description
AccessToken
  • string

Valid token issued by Twitch

CustomTags
  • object

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

ForceLink
  • boolean

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

LinkTwitchAccountResult

Error Codes

Name Code
AccountAlreadyLinked 1011
FeatureNotConfiguredForTitle 1177
InvalidTwitchToken 1232
LinkedAccountAlreadyClaimed 1012
TwitchResponseError 1233