Account Management - Add Generic ID

Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as authentication credentials, as the intent is that it is easily accessible by other players.

POST https://titleId.playfabapi.com/Server/AddGenericID

Request Header

Name Required Type Description
SecretKey True
  • string

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name Required Type Description
GenericId True

Generic service identifier to add to the player account.

PlayFabId True
  • string

PlayFabId of the user to link.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

AddGenericIDRequest
ApiErrorWrapper

The basic wrapper around every failed API response

EmptyResult
GenericServiceId

AddGenericIDRequest

Name Type Description
GenericId

Generic service identifier to add to the player account.

PlayFabId
  • string

PlayFabId of the user to link.

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

EmptyResult

GenericServiceId

Name Type Description
ServiceName
  • string

Name of the service for which the player has a unique identifier.

UserId
  • string

Unique identifier of the player in that service.

Error Codes

Name Code
IdentifierAlreadyClaimed 1238
UserisNotValid 1030