Xsolla-logoXsolla Developers
or
To Publisher Account

Create reward chainServer-sideAdmin

post/v2/project/{project_id}/admin/reward_chain

Creates 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
Request Body schema: application/json
One of:

A reward chain.

required
(two-letter (object or null)) or (five-letter (object or null))

Object with localizations for item’s name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character language codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

One of:

Two-letter lowercase language codes.

en
string or null

English

ar
string or null

Arabic

bg
string or null

Bulgarian

cn
string or null

Chinese (Simplified)

cs
string or null

Czech

de
string or null

German

es
string or null

Spanish (Spain)

fr
string or null

French

he
string or null

Hebrew

it
string or null

Italian

ja
string or null

Japanese

ko
string or null

Korean

pl
string or null

Polish

pt
string or null

Portuguese

ro
string or null

Romanian

ru
string or null

Russian

th
string or null

Thai

tr
string or null

Turkish

tw
string or null

Chinese (Traditional)

vi
string or null

Vietnamese

km
string or null

Khmer

id
string or null

Indonesian

lo
string or null

Lao

my
string or null

Burmese

ph
string or null

Filipino

ne
string or null

Nepali

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

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

date_start
required
string <date-time>

Date when your reward chain starts.

required
Array of objects
Array
required
(two-letter (object or null)) or (five-letter (object or null))

Object with localizations for item’s name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character language codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

One of:

Two-letter lowercase language codes.

en
string or null

English

ar
string or null

Arabic

bg
string or null

Bulgarian

cn
string or null

Chinese (Simplified)

cs
string or null

Czech

de
string or null

German

es
string or null

Spanish (Spain)

fr
string or null

French

he
string or null

Hebrew

it
string or null

Italian

ja
string or null

Japanese

ko
string or null

Korean

pl
string or null

Polish

pt
string or null

Portuguese

ro
string or null

Romanian

ru
string or null

Russian

th
string or null

Thai

tr
string or null

Turkish

tw
string or null

Chinese (Traditional)

vi
string or null

Vietnamese

km
string or null

Khmer

id
string or null

Indonesian

lo
string or null

Lao

my
string or null

Burmese

ph
string or null

Filipino

ne
string or null

Nepali

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 contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.

quantity
required
integer

Item quantity.

Array of type = string (objects) or Array of type = date (objects) or Array of type = number (objects)
One of:
[ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
attribute
required
string [ 1 .. 255 ] characters ^[-_.\d\w]+$

User attribute code.

operator
required
string

Type of operation performed by condition. For string attribute type.

Enum: Description
eq

Equals

ne

Not equals

value
required
string <= 255 characters

Condition value which user attribute value will be compared to. Type depends on attribute type.

type
required
string

User attribute type.

Value: "string"
can_be_missing
boolean

Indicates that the condition is met even if attribute is missing from user attributes. Pass true to show the item to users who don't have this attribute. Users who have the attribute, but the value does not match that specified in the condition, will not see the item. false — users who have the attribute, but the value does not match that specified in the condition, or the attribute is missing, will not see the item.

image_url
string or null

Image URL.

is_enabled
required
boolean
(two-letter (object or null)) or (five-letter (object or null))

Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

One of:

Two-letter lowercase language codes.

en
string or null

English

ar
string or null

Arabic

bg
string or null

Bulgarian

cn
string or null

Chinese (Simplified)

cs
string or null

Czech

de
string or null

German

es
string or null

Spanish (Spain)

fr
string or null

French

he
string or null

Hebrew

it
string or null

Italian

ja
string or null

Japanese

ko
string or null

Korean

pl
string or null

Polish

pt
string or null

Portuguese

ro
string or null

Romanian

ru
string or null

Russian

th
string or null

Thai

tr
string or null

Turkish

tw
string or null

Chinese (Traditional)

vi
string or null

Vietnamese

km
string or null

Khmer

id
string or null

Indonesian

lo
string or null

Lao

my
string or null

Burmese

ph
string or null

Filipino

ne
string or null

Nepali

(two-letter (object or null)) or (five-letter (object or null))

Object with localizations for long description of item. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both variants for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

Any of:

Two-letter lowercase language codes.

en
string or null

English

ar
string or null

Arabic

bg
string or null

Bulgarian

cn
string or null

Chinese (Simplified)

cs
string or null

Czech

de
string or null

German

es
string or null

Spanish (Spain)

fr
string or null

French

he
string or null

Hebrew

it
string or null

Italian

ja
string or null

Japanese

ko
string or null

Korean

pl
string or null

Polish

pt
string or null

Portuguese

ro
string or null

Romanian

ru
string or null

Russian

th
string or null

Thai

tr
string or null

Turkish

tw
string or null

Chinese (Traditional)

vi
string or null

Vietnamese

km
string or null

Khmer

id
string or null

Indonesian

lo
string or null

Lao

my
string or null

Burmese

ph
string or null

Filipino

ne
string or null

Nepali

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.

Array of type = string (objects) or Array of type = date (objects) or Array of type = number (objects)
One of:
[ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
attribute
required
string [ 1 .. 255 ] characters ^[-_.\d\w]+$

User attribute code.

operator
required
string

Type of operation performed by condition. For string attribute type.

Enum: Description
eq

Equals

ne

Not equals

value
required
string <= 255 characters

Condition value which user attribute value will be compared to. Type depends on attribute type.

type
required
string

User attribute type.

Value: "string"
can_be_missing
boolean

Indicates that the condition is met even if attribute is missing from user attributes. Pass true to show the item to users who don't have this attribute. Users who have the attribute, but the value does not match that specified in the condition, will not see the item. false — users who have the attribute, but the value does not match that specified in the condition, or the attribute is missing, will not see the item.

is_always_visible
boolean
Default: true

Whether the reward chain is visible to all users:

  • If true, the chain is always displayed, regardless of the user's authentication status or attributes.
  • If false, the chain is displayed only if no suitable reward chain is found. For example, if the user is not authenticated or their attributes don’t match any personalized chain.

Applies only in the context of personalized reward chains and is used if the attribute_conditions array is not passed.

Responses
201

Reward chain was successfully created.

401

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

422

Invalid request.

Request samples
application/json
{
  • "name": {
    },
  • "description": {
    },
  • "long_description": {
    },
  • "is_enabled": true,
  • "order": 1,
  • "date_start": "2020-04-15T18:16:00+05:00",
  • "date_end": "2021-04-15T18:16:00+05:00",
  • "value_point": {
    },
  • "steps": [],
  • "recurrent_schedule": {
    },
  • "attribute_conditions": [
    ],
  • "is_always_visible": true
}
Response samples
application/json
{
  • "reward_chain_id": 10
}