Challenges
get
Authorizations
Responses
200
Successful response
application/json
get
GET /partner-api/v2/admin/challenges 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"
}
}
}
}post
Authorizations
Body
challenge_typestringOptional
The type of challenge the streak encompasses.
activity_type_idsarrayOptional
One or more activity types needed to be completed to complete the quest..
starts_atnumberOptional
When the challenge should start, in epoch seconds.
ends_atnumberOptional
When the challenge should end, in epoch seconds.
program_segment_idsarrayOptional
Which program segments (if any) the challenge should apply to.
prize_point_reward_valuenumberOptional
the amount of points to reward for completing the quest
prize_loot_box_idstringOptional
the ID of a lootbox to reward for completing the quest
prize_nft_loyalty_reward_idnumberOptional
the ID of a reward to reward for completing the quest
calendar_intervalstringOptional
The interval of the streak.
intervals_required_to_completenumberOptional
The number of intervals needed to complete the quest.
value_thresholdnumberOptional
The value threshold to complete the requirement.
max_num_of_completions_for_programnumberOptional
The maximum number of times this quest can be completed for the program.
restricted_to_idsarrayOptional
Menu item or group IDs to fulfill the requirements, array of comma-separated ids
Responses
200
Successful response
application/json
post
POST /partner-api/v2/admin/challenges HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 331
"challenge_type='text'&activity_type_ids=[]&starts_at=1&ends_at=1&program_segment_ids=[]&prize_point_reward_value=1&prize_loot_box_id='text'&prize_nft_loyalty_reward_id=1&calendar_interval='text'&intervals_required_to_complete=1&value_threshold=1&max_num_of_completions_for_program=1&restricted_to_ids=[]"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"
}
}
}
}patch
Authorizations
Path parameters
challenge_idstringRequired
The Id of the challenge.
Body
challenge_typestringOptional
The type of challenge the streak encompasses.
activity_type_idsarrayOptional
One or more activity types needed to be completed to complete the quest..
starts_atnumberOptional
When the challenge should start, in epoch seconds.
ends_atnumberOptional
When the challenge should end, in epoch seconds.
program_segment_idsarrayOptional
Which program segments (if any) the challenge should apply to.
prize_point_reward_valuenumberOptional
the amount of points to reward for completing the quest
prize_loot_box_idstringOptional
the ID of a lootbox to reward for completing the quest
prize_nft_loyalty_reward_idnumberOptional
the ID of a reward to reward for completing the quest
calendar_intervalstringOptional
The interval of the streak.
intervals_required_to_completenumberOptional
The number of internvals needed to complete the quest.
value_thresholdnumberOptional
The value threshold to complete the requirement.
max_num_of_completions_for_programnumberOptional
The maximum number of times this quest can be completed for the program.
has_updated_menu_sampling_configbooleanOptional
Whether new menu items are included in this request
restricted_to_idsarrayOptional
Menu item or group IDs to fulfill the requirements, array of comma-separated ids
quest_requirementsarrayOptional
An array of quest requirements
Responses
200
Successful response
application/json
patch
PATCH /partner-api/v2/admin/challenges/{challenge_id} HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 395
"challenge_type='text'&activity_type_ids=[]&starts_at=1&ends_at=1&program_segment_ids=[]&prize_point_reward_value=1&prize_loot_box_id='text'&prize_nft_loyalty_reward_id=1&calendar_interval='text'&intervals_required_to_complete=1&value_threshold=1&max_num_of_completions_for_program=1&has_updated_menu_sampling_config=true&restricted_to_ids=[]&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"
}
}
}
}