Rewards
Create a Simple reward
Create a new simple reward. ⚠️ Action methods are available only in Enterprise interface.
post/rewards/actions/create-simple-reward
Headers
Accept-Languagestring
The unique ID of the language code by ISO 639-1.
Request body
Example request
{
"simple_reward": {
"reward_id": "83cfee22eabfbbb15a14815e30",
"code": "BIRTHDAY20",
"names": [
{
"language_code": "en",
"text": "Shoppers can earn exciting rewards for every purchase made at our store. Accumulated points can be redeemed for discounts, special offers, and exclusive products. Keep an eye out for seasonal promotions where rewards can multiply. Remember to check your rewards balance regularly to take full advantage of your benefits."
}
],
"notes": [
{
"language_code": "en",
"text": "Shoppers can earn exciting rewards for every purchase made at our store. Accumulated points can be redeemed for discounts, special offers, and exclusive products. Keep an eye out for seasonal promotions where rewards can multiply. Remember to check your rewards balance regularly to take full advantage of your benefits."
}
],
"subtitles": [
{
"language_code": "en",
"text": "Shoppers can earn exciting rewards for every purchase made at our store. Accumulated points can be redeemed for discounts, special offers, and exclusive products. Keep an eye out for seasonal promotions where rewards can multiply. Remember to check your rewards balance regularly to take full advantage of your benefits."
}
],
"points_cost": 200,
"valid_date_from": "2025-01-01",
"valid_date_to": "2027-12-01",
"reward_type_id": "8fdd651ff3f615bcebebad87ce",
"reward_type_value": 15,
"maximum_discount_value": 15,
"minimum_purchase_value": 3000,
"stores": [
{
"store_id": "81eaeea13b8984a169c490a325"
}
],
"segments": [
{
"segment_id": "82de12eb8b138791e678fd11c3"
}
],
"priority": 5,
"image_urls": [
{
"language_code": "en",
"url": "https://example.com/images/voucher.png?lang=en"
}
],
"reward_external_urls": [
{
"language_code": "en",
"url": "https://example.com/images/voucher.png?lang=en"
}
],
"tags": [
{
"tag_id": "838b73aacb5ac326cec4030c80",
"name": "Recommended",
"text_id": "recommended_tag",
"state": 1,
"last_change": "2019-01-04 10:31:56"
}
],
"global_reward": true,
"partner_id": "86e05affc7a7abefcd513ab400",
"voucher_validity": "end_of_time_unit",
"voucher_validity_value": "2 years",
"voucher_code_generation_preference": "A",
"state": 1
}
}Response
Created
Example response
{
"data": {
"reward_id": "82d0f9d976dee39aacd13dc7ea"
}
}