Quest requirements

Create a new quest requirement.

post

Invoke this endpoint to add a new requirement to a quest.

Authorizations

Path parameters

quest_idanyrequired

the ID of the quest having a requirement added

Body

value_thresholdnumberrequired

the ActivityType value threshold needed to satisfy the QuestRequirement

descriptionstringrequired

a description of the quest requirement

activity_type_idstringrequired

the ID of the ActivityType that satisfies the QuestRequirement

prize_point_reward_valuenumberoptional

the amount of points to reward for completing the QuestRequirement

prize_loot_box_idstringoptional

the ID of a lootbox to reward for completing the QuestRequirement

prize_nft_loyalty_reward_idstringoptional

the ID of a reward to reward for completing the QuestRequirement

auto_claim_prizebooleanoptional

a boolean indicating if the prize should be automatically claimed when the QuestRequirement is completed

activity_type_subtypesarrayoptional

an array of ActivityTypeSubtype IDs that can be used to fulfill the QuestRequirement

check_in_interval_daysnumberoptional

If present, the cadence at which the user must perform the activity (e.g. a value of 3, with a value_threshold of 50 equates to spend $50 every 3 days).

cta_textstringoptional

Call to action description text.

cta_urlstringoptional

Call to action URL.

ordernumberoptional

If present, the order in which the requirement must be completed.

restricted_to_idsarrayoptional

a list containing IDs that are allowed to fulfill the QuestRequirement

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v2/admin/quests/{quest_id}/quest-requirements' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'value_threshold=1&description=text&activity_type_id=text&prize_point_reward_value=1&prize_loot_box_id=text&prize_nft_loyalty_reward_id=text&auto_claim_prize=true&activity_type_subtypes=&check_in_interval_days=1&cta_text=text&cta_url=text&order=1&restricted_to_ids='

200

200

{
  "quest_requirement": {
    "id": "text",
    "quest_id": "text",
    "created_at": 1,
    "description": "text",
    "value_threshold": "text",
    "order": 1,
    "check_in_interval_days": 1,
    "image_url": "text",
    "prize": {
      "point_reward_value": 1,
      "sponsor_name": "text",
      "lootbox": {
        "id": "text",
        "name": "text",
        "description": "text",
        "background_gradient_start_color": "text",
        "background_gradient_stop_color": "text",
        "image_box_together_url": "text",
        "reward_choices": [
          {
            "id": "text",
            "title": "text",
            "subtitle": "text",
            "category": "text",
            "point_reward_value": 1,
            "reward_uuids": [
              "text"
            ],
            "quantity": 1,
            "image": "text",
            "video": "text",
            "probability": 1,
            "current_tier_id": "text",
            "rewards": [
              {
                "uuid": "text",
                "name": "text",
                "description": "text",
                "image_url": "text",
                "terms_and_conditions": "text",
                "metadata": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                }
              }
            ]
          }
        ],
        "metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "reward": {
        "uuid": "text",
        "name": "text",
        "description": "text",
        "image_url": "text",
        "terms_and_conditions": "text"
      }
    },
    "cta_url": "text",
    "cta_text": "text",
    "restricted_to_ids": "text",
    "activity_type_id": "text",
    "activity_type_name": "text",
    "activity_type_subtypes": [
      "text"
    ],
    "partner_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "prize_nft_loyalty_reward_id": "text",
    "prize_point_reward_value": 1,
    "prize_loot_box_id": "text",
    "auto_claim_prize": true
  }
}

Successful response