POST
/
player
/
achievement
curl --request POST \
  --url https://partners-api.forge.gg/player/achievement \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '{
  "achievement_title": "Sample achievement title",
  "achievement_description": "Optional: Achievement description",
  "unlock_time": "2024-07-16 19:20:30",
  "unlocked": true,
  "user_email": "user@example.com",
  "wallet_address": "0x1234567890abcdef",
  "blockchain": "ethereum"
}'
{
  "records_processed": 10
}

Headers

​
X-API-Key
string
required

Body

application/json
​
achievement_title
string
required

In game achievement name.

Example:

"Sample achievement title"

​
achievement_description
string
required

A short description to describe the given achievement.

Example:

"Optional: Achievement description"

​
unlocked
boolean
required

Indicator showing the achievement is ‘achieved’ for the user.

Example:

true

​
user_email
string
required

Email address used by the user to connect to the game.

Example:

"user@example.com"

​
unlock_time
string

Timestamp at which the achievement is ‘achieved’ in game.
Format: YYYY-MM-DD HH:mm:ss

Example:

"2024-07-16 19:20:30"

​
wallet_address
string

Any web3 wallet used by the user to connect to the game.

Example:

"0x1234567890abcdef"

​
blockchain
enum<string>

Blockchain associated with the shared wallet address.

Available options:
avalanche,
base,
ethereum,
polygon,
ronin,
solana,
sui
Example:

"ethereum"

Response

200
application/json
Successful response
​
records_processed
integer
Example:

10

Was this page helpful?

Suggest editsRaise issue