Account Management - Link Custom ID

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

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

Request Header

Name Required Type Description
SessionTicket True
  • string

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

Request Body

Name Required Type Description
CustomId True
  • 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.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

SessionTicket

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

LinkCustomIDRequest
LinkCustomIDResult

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

LinkCustomIDRequest

Name Type Description
CustomId
  • 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.

LinkCustomIDResult

Error Codes

Name Code
LinkedIdentifierAlreadyClaimed 1184