Xsolla-logo

Update reward chainServer-sideAdmin

put/v2/project/{project_id}/admin/reward_chain/id/{reward_chain_id}

Updates particular reward chain.

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056
reward_chain_id
required
integer

Reward chain ID.

Example: 101
Request Body schema: application/json
One of:

A reward chain.

required
object

Object with localizations for item's name. Two-letter lowercase language code.

en
string or null
ar
string or null
bg
string or null
cn
string or null
cs
string or null
de
string or null
es
string or null
fr
string or null
he
string or null
it
string or null
ja
string or null
ko
string or null
pl
string or null
pt
string or null
ro
string or null
ru
string or null
th
string or null
tr
string or null
tw
string or null
vi
string or null
date_start
required
string <date-time>

Date when your reward chain starts.

required
Array of objects
Array
required
object

Object with localizations for item's name. Two-letter lowercase language code.

en
string or null
ar
string or null
bg
string or null
cn
string or null
cs
string or null
de
string or null
es
string or null
fr
string or null
he
string or null
it
string or null
ja
string or null
ko
string or null
pl
string or null
pt
string or null
ro
string or null
ru
string or null
th
string or null
tr
string or null
tw
string or null
vi
string or null
required
object
amount
required
integer

Step price in value points.

required
Array of objects
Array
sku
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\\-–.]*$

Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, periods, dashes, and underscores.

quantity
required
integer

Item quantity.

step_id
required
integer or null

Unique step ID.

image_url
string or null

Image URL.

is_enabled
required
boolean
object

Object with localizations for item's description. Two-letter lowercase language code.

en
string or null
ar
string or null
bg
string or null
cn
string or null
cs
string or null
de
string or null
es
string or null
fr
string or null
he
string or null
it
string or null
ja
string or null
ko
string or null
pl
string or null
pt
string or null
ro
string or null
ru
string or null
th
string or null
tr
string or null
tw
string or null
vi
string or null
object

Object with localizations for long description of item. Two-letter lowercase language code.

en
string or null
ar
string or null
bg
string or null
cn
string or null
cs
string or null
de
string or null
es
string or null
fr
string or null
he
string or null
it
string or null
ja
string or null
ko
string or null
pl
string or null
pt
string or null
ro
string or null
ru
string or null
th
string or null
tr
string or null
tw
string or null
vi
string or null
image_url
string or null

Image URL.

order
integer

Defines arrangement order.

date_end
string or null <date-time>

Date when your reward chain promotion ends. Can be null. If date_end is null, the reward chain will be unlimited by time.

(interval_type = weekly (object or null)) or (interval_type = monthly (object or null))

Recurrent reset period of the reward chain.

One of:

Weekly type of reward chain refresh.

interval_type
required
string

Frequency of the recurrent reset of the reward chain.

Value: "weekly"
time
required
string((0[0-9]|1[0-9]|2[0-3]):00:00)(\+|-)(0[0-9]|1...

Time when the reward chain is reset in the desired time zone (rounding to hours).

For example, the set time for the reward chain reset is 01:00 for the Kuala Lumpur time zone (GMT+8). In this case, the value of the time parameter is 01:00:00+08:00.

day_of_week
required
integer [ 1 .. 7 ]

Day of the week when the reward chain is reset, where 1 is Monday and 7 is Sunday.

Responses
204

Reward chain was successfully updated.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

404

Reward chain not found.

422

Invalid request.

Request samples
application/json
{}
Response samples
application/json
{
  • "statusCode": 401,
  • "errorCode": 1020,
  • "errorMessage": "[0401-1020]: Error in Authentication method occurred"
}