Documentation

LinkServerCustomId

Links the custom server identifier, generated by the title, to the user's PlayFab account.

Request Details

LinkServerCustomIdRequest
Request Properties
ForceLink Boolean

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

PlayFabId (required) String

Unique PlayFab identifier.

ServerCustomId (required) String

Unique server custom identifier for this player.

POST https://{{TitleID}}.playfabapi.com/Server/LinkServerCustomId
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "PlayFabId": "123412341234",
  "ServerCustomId": "67AB-5397-CC54-EA31"
}
        

Response Details

LinkServerCustomIdResult
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

SecretKey

Possible Error Codes

Name Code
AccountNotFound 1001
LinkedIdentifierAlreadyClaimed 1184