Account Management - Link Facebook Instant Games Id

Links the Facebook Instant Games Id to the user's PlayFab account

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

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

string

Facebook Instant Games signature for the user.

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 Facebook Instant Games ID, unlink the other user and re-link.

Responses

Name Type Description
200 OK

LinkFacebookInstantGamesIdResult

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

LinkFacebookInstantGamesIdRequest
LinkFacebookInstantGamesIdResult

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

LinkFacebookInstantGamesIdRequest

Name Type Description
CustomTags

object

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

FacebookInstantGamesSignature

string

Facebook Instant Games signature for the user.

ForceLink

boolean

If another user is already linked to the Facebook Instant Games ID, unlink the other user and re-link.

LinkFacebookInstantGamesIdResult

Error Codes

Name Code
FacebookInstantGamesAuthNotConfiguredForTitle 1397
InvalidFacebookInstantGamesSignature 1396
LinkedIdentifierAlreadyClaimed 1184