Create daily reward

Xsolla Developers

To Publisher Account

Create daily rewardServer-sideAdmin

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

Creates a daily reward.

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 daily reward.

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

date_start

required

string <date-time>

Date when your daily reward starts.

required

Array of objects

Array

step_number

required

integer >= 1

Step number.

required

Array of objects non-empty

Array (non-empty)

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 >= 1 Daily reward step quantity for this sku

is_enabled

required

boolean

type

required

string

Type of daily reward which dictates when users can claim their rewards.

Value:	Description
calendar_hard	Next step reward is always unlocked every 24 hours. Any unclaimed step rewards are lost forever when the next step reward becomes available.

order

integer

Defines arrangement order.

(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

is_recurrent

boolean

Default: false

Whether the daily reward recurrent. If true, the daily reward is recurrent and will automatically reset after the end date. The next start_date and end_date schedule is based on the number of daily reward steps and initial time set on start_date.

Responses

201

Daily reward was successfully created.

401

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

422

Incorrect daily reward configuration errors.

Request samples

application/json

{"name": {"en": "New daily reward",
"ru": "Новая ежедневная награда"
},
"description": {"en": "New daily reward short description"
},
"order": 4,
"date_start": "2023-04-15T18:16:00+05:00",
"is_enabled": true,
"steps": [{"step_number": 1,
"items": [{"sku": "vg_enabled_shown_in_store_1",
"quantity": 2
}
]
},
{"step_number": 2,
"items": [{"sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg",
"quantity": 2
}
]
},
{"step_number": 3,
"items": [{"sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1",
"quantity": 2
}
]
},
{"step_number": 4,
"items": [{"sku": "vg_enabled_shown_in_store_1",
"quantity": 1
}
]
},
{"step_number": 5,
"items": [{"sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg",
"quantity": 1
}
]
},
{"step_number": 6,
"items": [{"sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1",
"quantity": 1
}
]
}
],
"type": "calendar_hard"
}

Response samples

application/json

{"daily_chain_id": 10
}