Coin Codes

Coin Codes can be used by players to redeem in-game coins and/or a coin code item - they can only be redeemed once per player and can optionally have a limit on how many times they can be redeemed across all players. On this page we'll dive into the different coin code endpoints you can use to manage coin codes programmatically.

The coin code model

The coin code model contains all the information about coin codes.

Properties

Name
id
Type
integer
Description
Unique identifier for the coin code.
Name
coins
Type
nullable integer
Description
Coins to be earned when redeeming the coin code.
Name
item
Type
nullable object
Description
Item to be earned when redeeming the coin code.

POST/coin-codes/redeem

Redeem a coin code

This endpoint allows you to redeem a coin code. To redeem a coin code, you must provide the code.

Required attributes

Name
code
Type
string
Description
The code for the coin code.

Request

POST

/coin-codes/redeem

curl https://prod-app.themeparkshark.com/api/coin-codes/redeem \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d code=QF5C7X0TN

Response

{
  "data": {
    "id": 1,
    "coins": 0,
    "item": {
      "id": 1,
      "name": "Future Hat",
      "icon_url": "https://assets.themeparkshark.com/mobile/production/assets/image.png"
    }
  }
}