Claim an achievement by request name

post https://us-central1-readysandbox.cloudfunctions.net/achievements-claimByRequestName

Responses

Response body

object

rewardsHaveBeenGivenOut

boolean

Indicates whether rewards have been given out

rewards

array of objects

rewards

object

type

string

required

The type of reward this achievement offers.
Supported reward types are:

currency - the reward is a quantity of currency coins. The name field is the name of the currency.
addGlobalCurrency - the reward is a quantity of global currency coins. The name field is the name of the currency.
addRDYXBasedOnUSDTGlobalCurrency - the reward is a quantity of RDYX based on the USDT global currency the user will get when completes the achievement. The name field is always USDT.
item_by_id - the reward is a quantity of a virtual items. The name field is the id of the virtual item.
progression - the reward is a quantity of progression. The name field is the id/name of the progression.
setLeaderboardScore - the reward is a quantity of leaderboard score to set. The name field is the id of the leaderboard.
addLeaderboardScore - the reward is a quantity of leaderboard score to add. The name field is the id of the leaderboard.
gamepass_by_id - the reward is a quantity of game passes to add. The name field is the id of the game pass.
gamepass_by_request_name - the reward is a quantity of game passes to add. The name field is the request name of the game pass.

currency addGlobalCurrency addRDYXBasedOnUSDTGlobalCurrency item_by_id progression setLeaderboardScore addLeaderboardScore gamepass_by_id gamepass_by_request_name

appIds

array of strings

required

The list of application IDs for which this achievement reward is applicable. This allows rewards to be scoped to specific applications within a developer's portfolio.

appIds*

name

string

required

The name of the reward. This could be the id of the virtual item, currency name, progression id, or leaderboard id.

quantity

int32

required

The quantity of the reward that will be given to the user upon completing the achievement. For "virtualItem" and "currency", it represents the number of items or coins rewarded. For "progression", it represents the increment value for the user's progression. For "setLeaderboardScore", it represents the score that will be set for the current user to the leaderboard. For "addLeaderboardScore", it represents the score that will be added for the current user to the leaderboard.

400

Invalid argument

410

Achievement not found

412

Precondition failed - achievement not completed or already claimed

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://us-central1-readysandbox.cloudfunctions.net/achievements-claimByRequestName \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
13
 
1
{
2
  "rewardsHaveBeenGivenOut": true,
3
  "rewards": [
4
    {
5
      "type": "currency",
6
      "appIds": [
7
        "string"
8
      ],
9
      "name": "string",
10
      "quantity": 0
11
    }
12
  ]
13
}

200Successful operation

401Unauthenticated error 401 indicating the user is not authenticated.