Quest requirements

Create a new quest requirement.

post

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

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

quest_idstringRequired

the ID of the quest having a requirement added

Body

application/x-www-form-urlencoded

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

200

Successful response

application/json

post

/v2/admin/quests/{quest_id}/quest-requirements

HTTPcURLJavaScriptPython

POST /partner-api/v2/admin/quests/{quest_id}/quest-requirements HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 308

"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

Successful response

{
  "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
  }
}