Quest requirements

Update a quest requirement.

patch

Invoke this endpoint to update a quest requirement.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

quest_requirement_idstringRequired

The ID of the quest requirement.

Body

application/x-www-form-urlencoded

quest_idstringOptional

The ID of the associated quest.

activity_type_idstringOptional

The ID of the activity type that satisfies the quest requirement.

descriptionstringOptional

A description of the quest requirement.

value_thresholdnumberOptional

The activity type value threshold needed to satisfy the quest requirement.

prize_point_reward_valuenumberOptional

The amount of points earned by completing the quest requirement.

prize_loot_box_idstringOptional

The ID of the lootbox earned by completing the quest requirement.

prize_nft_loyalty_reward_idstringOptional

The ID of the reward earned by completing the quest requirement.

auto_claim_prizebooleanOptional

A boolean indicating if the prize should automatically be claimed when the quest requirement is completed.

activity_type_subtypesarrayOptional

An array of activity type subtype IDs that can be used to fulfill the quest requirement.

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).

image_urlstringOptional

The url of the image for the quest requirement.

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 quest requirement.

Responses

200

Successful response

application/json

patch

/v2/admin/quest-requirements/{quest_requirement_id}

HTTPcURLJavaScriptPython

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

"quest_id='text'&activity_type_id='text'&description='text'&value_threshold=1&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&image_url='text'&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
  }
}