Account Management - Link Steam Id

Service:

Server

API Version:

240514

Links the Steam account associated with the provided Steam ID to the user's PlayFab account

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

Request Header

Name	Required	Type	Description
X-SecretKey	True	string	This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name	Required	Type	Description
PlayFabId	True	string	Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier.
SteamId	True	string	Unique Steam identifier for a 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 account, unlink the other user and re-link.

Responses

Name	Type	Description
200 OK	LinkSteamIdResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-SecretKey

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

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
LinkSteamIdRequest
LinkSteamIdResult

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

LinkSteamIdRequest

Name	Type	Description
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 account, unlink the other user and re-link.
PlayFabId	string	Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier.
SteamId	string	Unique Steam identifier for a user.

LinkSteamIdResult

Error Codes

Name	Code
AccountAlreadyLinked	1011
InvalidSteamTicket	1010
LinkedAccountAlreadyClaimed	1012
SteamNotEnabledForTitle	1258
SteamUserNotFound	1513