Quests

Get all quests for program.

get

Authorizations

Query parameters

limitnumberOptional

Amount of quests to return (max 20).

offsetnumberOptional

Index to start at.

Responses

get

HTTPcURLJavaScriptPython

GET /partner-api/v2/admin/quests HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "quests": [
    "text"
  ],
  "total_records": 1
}

Creates the quest with the provided fields.

post

Quests are a group of activity-thresholds (ordered or unordered) that customers need to meet in order to either unlock rewards/points for each activity-threshold, and/or rewards/points for completing the quest.

Authorizations

Body

quest_requirementsarrayRequired

An array of quest requirements

point_threshold_requirementnumberRequired

The threshold for required number of points.

descriptionstringRequired

A description of the quest.

ends_atnumberRequired

When the quest ends, in epoch seconds.

starts_atnumberRequired

When the quest starts, in epoch seconds.

opt_in_textstringRequired

The text to display when opting in to a quest.

namestringRequired

The name of the quest.

prioritynumberOptional

The display priority of the quest.

quest_typestringOptional

The type of quest.

sponsor_namestringOptional

The name of the quest sponsor.

calendar_intervalstringOptional

When the quest cycle ends. Values are daily, weekly, monthly, bimonthly, quarterly, yearly and unset.

max_num_of_completions_per_usernumberOptional

The maximum number of times a user can complete the quest.

max_num_of_completions_for_programnumberOptional

The maximum number of times the quest can be completed for the program.

terms_and_conditionsstringOptional

The terms and conditions of the quest.

auto_opt_in_at_signupbooleanOptional

Whether users should be automatically opted in to the quest at sign up.

auto_claim_prizebooleanOptional

Whether users should automatically receive the prize

claim_prize_header_textstringOptional

Header text for claiming prize screen.

claim_prize_messagestringOptional

Message text for claiming prize screen.

claim_prize_ctastringOptional

Call to action text for claiming prize

prize_nft_loyalty_reward_idstringOptional

The id of the Loyalty Reward for completing quest.

prize_point_reward_valuenumberOptional

The point value for completing the quest.

prize_loot_box_idstringOptional

The id of the Loot Box for completing quest.

image_urlstringOptional

The url of the image for the quest.

statusstringOptional

The status of the quest.

time_to_complete_minutesnumberOptional

The amount of time a user has to complete the quest.

Responses

post

HTTPcURLJavaScriptPython

POST /partner-api/v2/admin/quests HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 623

"quest_requirements=[]&point_threshold_requirement=1&description='text'&ends_at=1&starts_at=1&opt_in_text='text'&name='text'&priority=1&quest_type='text'&sponsor_name='text'&calendar_interval='text'&max_num_of_completions_per_user=1&max_num_of_completions_for_program=1&terms_and_conditions='text'&auto_opt_in_at_signup=true&auto_claim_prize=true&claim_prize_header_text='text'&claim_prize_message='text'&claim_prize_cta='text'&prize_nft_loyalty_reward_id='text'&prize_point_reward_value=1&prize_loot_box_id='text'&image_url='text'&status='text'&time_to_complete_minutes=1"

200

Successful response

{
  "quest": {
    "id": "text",
    "name": "text",
    "priority": 1,
    "description": "text",
    "sponsor_name": "text",
    "image_url": "text",
    "point_threshold_requirement": 1,
    "opt_in_text": "text",
    "time_to_complete_minutes": 1,
    "starts_at": 1,
    "ends_at": 1,
    "status": "draft",
    "max_num_of_completions_per_user": 1,
    "max_num_of_completions_for_program": 1,
    "quest_type": "text",
    "auto_opt_in_at_signup": true,
    "partner_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_at": 1,
    "terms_and_conditions": "text",
    "auto_claim_prize": true,
    "enforce_order": true,
    "claim_prize_header_text": "text",
    "claim_prize_message": "text",
    "claim_prize_cta": "text",
    "remaining_num_of_completions_for_program": 1,
    "quest_requirements": [
      "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"
      }
    }
  }
}

Get quest by Id.

get

Authorizations

Path parameters

quest_idstringRequired

The Id of the quest.

Responses

get

HTTPcURLJavaScriptPython

GET /partner-api/v2/admin/quests/{quest_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "quest": {
    "id": "text",
    "name": "text",
    "priority": 1,
    "description": "text",
    "sponsor_name": "text",
    "image_url": "text",
    "point_threshold_requirement": 1,
    "opt_in_text": "text",
    "time_to_complete_minutes": 1,
    "starts_at": 1,
    "ends_at": 1,
    "status": "draft",
    "max_num_of_completions_per_user": 1,
    "max_num_of_completions_for_program": 1,
    "quest_type": "text",
    "auto_opt_in_at_signup": true,
    "partner_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_at": 1,
    "terms_and_conditions": "text",
    "auto_claim_prize": true,
    "enforce_order": true,
    "claim_prize_header_text": "text",
    "claim_prize_message": "text",
    "claim_prize_cta": "text",
    "remaining_num_of_completions_for_program": 1,
    "quest_requirements": [
      "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"
      }
    }
  }
}

Updates the quest with the provided fields.

patch

Quests are a group of activity-thresholds (ordered or unordered) that customers need to meet in order to either unlock rewards/points for each activity-threshold, and/or rewards/points for completing the quest.

Authorizations

Path parameters

quest_idstringRequired

The Id of the quest.

Body

namestringOptional

The name of the quest.

prioritynumberOptional

The display priority of the quest.

opt_in_textstringOptional

The text to display when opting in to a quest.

quest_typestringOptional

The type of quest.

sponsor_namestringOptional

The name of the quest sponsor.

starts_atnumberOptional

When the quest starts, in epoch seconds.

ends_atnumberOptional

When the quest ends, in epoch seconds.

calendar_intervalstringOptional

When the quest cycle ends. Values are daily, weekly, monthly, bimonthly, quarterly, yearly and unset.

descriptionstringOptional

A description of the quest.

point_threshold_requirementnumberOptional

The threshold for required number of points.

max_num_of_completions_per_usernumberOptional

The maximum number of times a user can complete the quest.

max_num_of_completions_for_programnumberOptional

The maximum number of times the quest can be completed for the program.

terms_and_conditionsstringOptional

The terms and conditions of the quest.

auto_opt_in_at_signupbooleanOptional

Whether users should be automatically opted in to the quest at sign up.

auto_claim_prizebooleanOptional

Whether users should automatically receive the prize

claim_prize_header_textstringOptional

Header text for claiming prize screen.

claim_prize_messagestringOptional

Message text for claiming prize screen.

claim_prize_ctastringOptional

Call to action text for claiming prize

prize_nft_loyalty_reward_idstringOptional

The id of the Loyalty Reward for completing quest.

prize_point_reward_valuenumberOptional

The point value for completing the quest.

prize_loot_box_idstringOptional

The id of the Loot Box for completing quest.

image_urlstringOptional

The url of the image for the quest.

statusstringOptional

The status of the quest.

time_to_complete_minutesnumberOptional

The amount of time a user has to complete the quest.

quest_requirementsarrayOptional

An array of quest requirements

Responses

patch

HTTPcURLJavaScriptPython

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

"name='text'&priority=1&opt_in_text='text'&quest_type='text'&sponsor_name='text'&starts_at=1&ends_at=1&calendar_interval='text'&description='text'&point_threshold_requirement=1&max_num_of_completions_per_user=1&max_num_of_completions_for_program=1&terms_and_conditions='text'&auto_opt_in_at_signup=true&auto_claim_prize=true&claim_prize_header_text='text'&claim_prize_message='text'&claim_prize_cta='text'&prize_nft_loyalty_reward_id='text'&prize_point_reward_value=1&prize_loot_box_id='text'&image_url='text'&status='text'&time_to_complete_minutes=1&quest_requirements=[]"

200

Successful response

{
  "quest": {
    "id": "text",
    "name": "text",
    "priority": 1,
    "description": "text",
    "sponsor_name": "text",
    "image_url": "text",
    "point_threshold_requirement": 1,
    "opt_in_text": "text",
    "time_to_complete_minutes": 1,
    "starts_at": 1,
    "ends_at": 1,
    "status": "draft",
    "max_num_of_completions_per_user": 1,
    "max_num_of_completions_for_program": 1,
    "quest_type": "text",
    "auto_opt_in_at_signup": true,
    "partner_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_at": 1,
    "terms_and_conditions": "text",
    "auto_claim_prize": true,
    "enforce_order": true,
    "claim_prize_header_text": "text",
    "claim_prize_message": "text",
    "claim_prize_cta": "text",
    "remaining_num_of_completions_for_program": 1,
    "quest_requirements": [
      "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"
      }
    }
  }
}