HAhang
Rewards

Endpoint to create a reward.

post/v2/admin/rewards

Request

Request body multipart/form-data

reward_group'trait_or_program_reward' | 'bonus_reward' required

The reward group of the reward (defaults to "trait_or_program_reward").

start_datenumber required

When the reward can be redeemed, in epoch seconds.

namestring required

Name/title of the reward.

descriptionstring

Description of the reward.

terms_and_conditionsstring

Terms and conditions of the reward.

end_datenumber

When the reward can no longer be redeemed, in epoch seconds.

redemption_method'code' | 'store_link' | 'promo_code'

The method with which the reward should be redeemed (defaults to "code").

status'draft' | 'published'

The status of the reward indicating whether the reward is live or not (defaults to "draft").

intervalnumber

How often the user can redeem the reward in days, if 0 then unlimited.

limitnumber

Maximum amount of times a user can receive the reward.

prioritynumber

Priority of the reward, influences how the reward is displayed to the user. Rewards are displayed in ascending order of priority.

pos_instructionsstring

Instructions on how to redeem the reward (brand-facing).

redemption_instructionsstring

Instructions on how to redeem the reward (user-facing).

reward_type'redemption' | 'discount_percent_based' | 'discount_value_based' | 'access' | 'achievement' | 'puzzle_piece'

The type of reward (defaults to "redemption").

reward_valuenumber

The discount amount for this reward. Only applies to discount_percent_based and discount_value_based reward types.

achievement_idnumber

the id of the reward achievement.

controlled_by'auto' | 'brand'

Who controls the reward (defaults to "auto").

image_urlstring

URL of the reward image.

video_urlstring

URL of the reward video.

default_loot_box_reward_image_urlstring

URL of the default lootbox reward image.

redemption_stepsstring[]

List of redemption steps.

store_discount_urlstring

URL of the store discount, required if redemption method is store_link.

promo_codestring

Promo code, required if redemption method is promo_code.

Response

Successful response

rewardobject required

Changes

No recorded changes to this operation across all 1 revision of this API.