Rewards

Endpoint to retrieve a reward with given unique id.

get
Authorizations
Path parameters
reward_uuidanyrequired

The unique Id of the reward.

Responses
curl -L \
  --url '/v2/admin/rewards/{reward_uuid}' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "reward": {
    "name": "text",
    "uuid": "text",
    "description": "text",
    "terms_and_conditions": "text",
    "start_date": 1,
    "end_date": 1,
    "redemption_method": "code",
    "status": "draft",
    "interval": 1,
    "limit": 1,
    "priority": 1,
    "pos_instructions": "text",
    "redemption_instructions": "text",
    "reward_group": "trait_or_program_reward",
    "is_program_reward": true,
    "is_promoted_reward": true,
    "reward_type": "redemption",
    "reward_value": 1,
    "achievement_id": "text",
    "controlled_by": "auto",
    "image_url": "text",
    "video_url": "text",
    "default_loot_box_reward_image_url": "text",
    "redemption_steps": [
      "text"
    ],
    "store_discount_url": "text",
    "promo_code": "text",
    "partner_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_at": 1,
    "updated_at": 1,
    "is_welcome_reward": true
  }
}

Successful response

Endpoint to update a reward.

patch
Authorizations
Path parameters
reward_uuidanyrequired

The unique Id of the reward.

Body
namestringoptional

Name/title of the reward.

descriptionstringoptional

Description of the reward.

terms_and_conditionsstringoptional

Terms and conditions of the reward.

start_datenumberoptional

When the reward can be redeemed, in epoch seconds.

end_datenumberoptional

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

redemption_methodstringoptional

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

statusstringoptional

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

intervalnumberoptional

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

limitnumberoptional

Maximum amount of times a user can receive the reward.

prioritynumberoptional

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

pos_instructionsstringoptional

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

redemption_instructionsstringoptional

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

reward_groupstringoptional

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

is_program_rewardbooleanoptional

A boolean indicating if the reward should be available by just being in the program. Only applies to trait_or_program_rewards.

trait_idsarrayoptional

The traits that grant access to this reward. Only applies to trait_or_program_rewards.

reward_typestringoptional

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

reward_valuenumberoptional

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

achievement_idnumberoptional

the id of the reward achievement.

controlled_bystringoptional

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

image_urlstringoptional

URL of the reward image.

video_urlstringoptional

URL of the reward video.

default_loot_box_reward_image_urlstringoptional

URL of the default lootbox reward image.

redemption_stepsarrayoptional

List of redemption steps.

store_discount_urlstringoptional

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

promo_codestringoptional

Promo code, required if redemption method is promo_code.

expiration_in_minutesnumberoptional

How long until a reward expires after being granted.

is_welcome_rewardbooleanoptional

A boolean indicating if the reward should be granted on sign up.

Responses
curl -L \
  --request PATCH \
  --url '/v2/admin/rewards/{reward_uuid}' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'name=text&description=text&terms_and_conditions=text&start_date=1&end_date=1&redemption_method=text&status=text&interval=1&limit=1&priority=1&pos_instructions=text&redemption_instructions=text&reward_group=text&is_program_reward=true&trait_ids=&reward_type=text&reward_value=1&achievement_id=1&controlled_by=text&image_url=text&video_url=text&default_loot_box_reward_image_url=text&redemption_steps=&store_discount_url=text&promo_code=text&expiration_in_minutes=1&is_welcome_reward=true'
{
  "reward": {
    "name": "text",
    "uuid": "text",
    "description": "text",
    "terms_and_conditions": "text",
    "start_date": 1,
    "end_date": 1,
    "redemption_method": "code",
    "status": "draft",
    "interval": 1,
    "limit": 1,
    "priority": 1,
    "pos_instructions": "text",
    "redemption_instructions": "text",
    "reward_group": "trait_or_program_reward",
    "is_program_reward": true,
    "is_promoted_reward": true,
    "reward_type": "redemption",
    "reward_value": 1,
    "achievement_id": "text",
    "controlled_by": "auto",
    "image_url": "text",
    "video_url": "text",
    "default_loot_box_reward_image_url": "text",
    "redemption_steps": [
      "text"
    ],
    "store_discount_url": "text",
    "promo_code": "text",
    "partner_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_at": 1,
    "updated_at": 1,
    "is_welcome_reward": true
  }
}

Successful response

Endpoint to create a reward.

post
Authorizations
Body
reward_groupstringrequired

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

start_datenumberrequired

When the reward can be redeemed, in epoch seconds.

namestringrequired

Name/title of the reward.

descriptionstringoptional

Description of the reward.

terms_and_conditionsstringoptional

Terms and conditions of the reward.

end_datenumberoptional

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

redemption_methodstringoptional

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

statusstringoptional

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

intervalnumberoptional

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

limitnumberoptional

Maximum amount of times a user can receive the reward.

prioritynumberoptional

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

pos_instructionsstringoptional

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

redemption_instructionsstringoptional

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

is_program_rewardbooleanoptional

A boolean indicating if the reward should be available by just being in the program. Only applies to trait_or_program_rewards.

is_welcome_rewardbooleanoptional

A boolean indicating if the reward should be granted on sign up.

trait_idsarrayoptional

The traits that grant access to this reward. Only applies to trait_or_program_rewards.

reward_typestringoptional

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

reward_valuenumberoptional

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

achievement_idnumberoptional

the id of the reward achievement.

controlled_bystringoptional

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

image_urlstringoptional

URL of the reward image.

video_urlstringoptional

URL of the reward video.

default_loot_box_reward_image_urlstringoptional

URL of the default lootbox reward image.

redemption_stepsarrayoptional

List of redemption steps.

store_discount_urlstringoptional

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

promo_codestringoptional

Promo code, required if redemption method is promo_code.

expiration_in_minutesnumberoptional

How long until a reward expires after being granted.

Responses
curl -L \
  --request POST \
  --url '/v2/admin/rewards' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'reward_group=text&start_date=1&name=text&description=text&terms_and_conditions=text&end_date=1&redemption_method=text&status=text&interval=1&limit=1&priority=1&pos_instructions=text&redemption_instructions=text&is_program_reward=true&is_welcome_reward=true&trait_ids=&reward_type=text&reward_value=1&achievement_id=1&controlled_by=text&image_url=text&video_url=text&default_loot_box_reward_image_url=text&redemption_steps=&store_discount_url=text&promo_code=text&expiration_in_minutes=1'
{
  "reward": {
    "name": "text",
    "uuid": "text",
    "description": "text",
    "terms_and_conditions": "text",
    "start_date": 1,
    "end_date": 1,
    "redemption_method": "code",
    "status": "draft",
    "interval": 1,
    "limit": 1,
    "priority": 1,
    "pos_instructions": "text",
    "redemption_instructions": "text",
    "reward_group": "trait_or_program_reward",
    "is_program_reward": true,
    "is_promoted_reward": true,
    "reward_type": "redemption",
    "reward_value": 1,
    "achievement_id": "text",
    "controlled_by": "auto",
    "image_url": "text",
    "video_url": "text",
    "default_loot_box_reward_image_url": "text",
    "redemption_steps": [
      "text"
    ],
    "store_discount_url": "text",
    "promo_code": "text",
    "partner_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_at": 1,
    "updated_at": 1,
    "is_welcome_reward": true
  }
}

Successful response

PreviousQuest requirementsNextBatch create