Quests
Amount of quests to return (max 20).
Index to start at.
GET /partner-api/v2/admin/quests HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Accept: */*
Successful response
{
"quests": [
"text"
],
"total_records": 1
}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.
An array of quest requirements
The threshold for required number of points.
A description of the quest.
When the quest ends, in epoch seconds.
When the quest starts, in epoch seconds.
The text to display when opting in to a quest.
The name of the quest.
The display priority of the quest.
The type of quest.
The name of the quest sponsor.
When the quest cycle ends. Values are daily, weekly, monthly, bimonthly, quarterly, yearly and unset.
The maximum number of times a user can complete the quest.
The maximum number of times the quest can be completed for the program.
The terms and conditions of the quest.
Whether users should be automatically opted in to the quest at sign up.
Whether users should automatically receive the prize
Header text for claiming prize screen.
Message text for claiming prize screen.
Call to action text for claiming prize
The id of the Loyalty Reward for completing quest.
The point value for completing the quest.
The id of the Loot Box for completing quest.
The url of the image for the quest.
The status of the quest.
The amount of time a user has to complete the quest.
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"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"
}
}
}
}The Id of the quest.
GET /partner-api/v2/admin/quests/{quest_id} HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Accept: */*
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"
}
}
}
}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.
The Id of the quest.
The name of the quest.
The display priority of the quest.
The text to display when opting in to a quest.
The type of quest.
The name of the quest sponsor.
When the quest starts, in epoch seconds.
When the quest ends, in epoch seconds.
When the quest cycle ends. Values are daily, weekly, monthly, bimonthly, quarterly, yearly and unset.
A description of the quest.
The threshold for required number of points.
The maximum number of times a user can complete the quest.
The maximum number of times the quest can be completed for the program.
The terms and conditions of the quest.
Whether users should be automatically opted in to the quest at sign up.
Whether users should automatically receive the prize
Header text for claiming prize screen.
Message text for claiming prize screen.
Call to action text for claiming prize
The id of the Loyalty Reward for completing quest.
The point value for completing the quest.
The id of the Loot Box for completing quest.
The url of the image for the quest.
The status of the quest.
The amount of time a user has to complete the quest.
An array of quest requirements
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=[]"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"
}
}
}
}