Account Management - Link Kongregate

Links the Kongregate identifier to the user's PlayFab account

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

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

string

Valid session auth ticket issued by Kongregate

KongregateId True

string

Numeric user ID assigned by Kongregate

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

LinkKongregateAccountResult

400 Bad Request

ApiErrorWrapper

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

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response

LinkKongregateAccountRequest
LinkKongregateAccountResult

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

LinkKongregateAccountRequest

Name Type Description
AuthTicket

string

Valid session auth ticket issued by Kongregate

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.

KongregateId

string

Numeric user ID assigned by Kongregate

LinkKongregateAccountResult

Error Codes

Name Code
FeatureNotConfiguredForTitle 1177
InvalidKongregateToken 1176
LinkedAccountAlreadyClaimed 1012