Documentation

LinkCustomID

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

Request Details

LinkCustomIDRequest
Request Properties
CustomId (required) String

Custom unique identifier for the user, generated by the title.

ForceLink Boolean

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

POST https://{{TitleID}}.playfabapi.com/Client/LinkCustomID
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{
  "CustomId": "67AB-5397-CC54-EA31"
}
        

Response Details

LinkCustomIDResult
Result Properties

Sample Response

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


Authentication

SessionTicket

Possible Error Codes

Name Code
LinkedIdentifierAlreadyClaimed 1184