Skip to main content
PATCH
/
v2
/
currency-offers
/
{currencyOffer}
Update a currency offer
curl --request PATCH \
  --url https://api.gameboost.com/v2/currency-offers/{currencyOffer} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "game_id": 123,
  "game": "<string>",
  "external_id": "<string>",
  "description": "<string>",
  "price": 0.015,
  "currency": "EUR",
  "stock": 1000000,
  "min_quantity": 1000,
  "delivery_instructions": "<string>",
  "excluded_delivery_fields": [],
  "delivery_time": {
    "duration": 2,
    "unit": "hours"
  },
  "currency_data": {
    "server": "EU",
    "faction": "Alliance"
  }
}
'
{
  "data": {
    "id": 123,
    "uuid": "<string>",
    "external_id": "<string>",
    "game": {
      "id": 123,
      "name": "<string>",
      "slug": "<string>"
    },
    "currency_unit": {
      "slug": "<string>",
      "currency_name": "<string>",
      "name": "<string>",
      "symbol": "<string>",
      "multiplier": 123
    },
    "title": "<string>",
    "description": "<string>",
    "parameters": {},
    "base_currency": "EUR",
    "delivery_time": {
      "duration": 123,
      "format": "<string>",
      "format_long": "<string>",
      "seconds": 123
    },
    "delivery_instructions": "<string>",
    "excluded_delivery_fields": [],
    "delivery_method_data": {},
    "stock": 123,
    "min_quantity": 123,
    "price_eur": "<string>",
    "price_usd": "<string>",
    "views": 123,
    "is_best_offer": true,
    "icon_url": "<string>",
    "created_at": 123,
    "updated_at": 123,
    "listed_at": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.gameboost.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
currencyOffer
string
required

The ID of the currency offer. Can be retrieved from the list of currency offers.

Body

application/json

Update currency offer - all fields are optional, only provide fields you want to update

​
game_id
integer

Unique identifier for the game (required if game slug not provided)

​
game
string

Slug of the game (required if game_id not provided)

​
external_id
string

External identifier for the currency offer, used to map to your own system

Maximum string length: 255
​
description
string

Detailed description of the currency and how it will be delivered

Maximum string length: 5028
​
price
number

Price per currency unit, up to 6 decimal places. Interpreted in the currency specified by the currency field (defaults to EUR). USD values are converted to EUR before storage.

Example:

0.015

​
currency
enum<string>
default:EUR

Currency the price is expressed in. EUR is stored as-is; USD is converted to EUR server-side. Defaults to EUR.

Available options:
EUR,
USD
Example:

"EUR"

​
stock
integer

Available quantity of currency units in stock

Required range: 0 <= x <= 1000000000
Example:

1000000

​
min_quantity
integer
default:1

Minimum quantity that can be purchased in a single order

Required range: 1 <= x <= 1000000000
Example:

1000

​
delivery_instructions
string

Special instructions for currency delivery, provided to buyer after purchase

​
delivery_method
enum<string> | null

Optional delivery method. If null, legacy currency precheckout behavior is used.

Available options:
none,
username,
login,
trade,
auction,
gift,
redeem,
mail
​
excluded_delivery_fields
enum<string>[] | null

Optional delivery fields disabled by the seller. Required fields for the selected method cannot be excluded.

Available options:
username,
server,
login,
password,
platform,
region
​
delivery_time
object

Expected delivery time object

Example:
{ "duration": 2, "unit": "hours" }
​
currency_data
object

Specifics available via the template endpoint. Game-specific currency attributes such as server, realm, or faction

Example:
{ "server": "EU", "faction": "Alliance" }

Response

A single currency offer

​
data
object

Currency offer object representing in-game currency for sale