Platform Specific Methods - Award Steam Achievement

Service:

Server

API Version:

241025

Awards the specified users the specified Steam achievements

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

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
Achievements	True	AwardSteamAchievementItem[]	Array of achievements to grant and the users to whom they are to be granted.

Responses

Name	Type	Description
200 OK	AwardSteamAchievementResult
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
AwardSteamAchievementItem
AwardSteamAchievementRequest
AwardSteamAchievementResult

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

AwardSteamAchievementItem

Name	Type	Description
AchievementName	string	Unique Steam achievement name.
PlayFabId	string	Unique PlayFab assigned ID of the user on whom the operation will be performed.
Result	boolean	Result of the award attempt (only valid on response, not on request).

AwardSteamAchievementRequest

Name	Type	Description
Achievements	AwardSteamAchievementItem[]	Array of achievements to grant and the users to whom they are to be granted.

AwardSteamAchievementResult

Name	Type	Description
AchievementResults	AwardSteamAchievementItem[]	Array of achievements granted.

Error Codes

Name	Code
UserisNotValid	1030