Quests

Updates the quest with the provided fields.

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.

patch/v2/admin/quests/{quest_id}

Request

Path parameters

quest_idstring required

The Id of the quest.

Request body multipart/form-data

namestring

The name of the quest.

opt_in_textstring

The text to display when opting in to a quest.

quest_typestring

The type of quest.

sponsor_namestring

The name of the quest sponsor.

starts_atnumber

When the quest starts, in epoch seconds.

ends_atnumber

When the quest ends, in epoch seconds.

descriptionstring

A description of the quest.

point_threshold_requirementnumber

The threshhold for required number of points.

max_num_of_completions_per_usernumber

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

max_num_of_completions_for_programnumber

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

terms_and_conditionsstring

The terms and conditions of the quest.

auto_opt_in_at_signupboolean

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

claim_prize_header_textstring

Header text for claiming prize screen.

claim_prize_messagestring

Message text for claiming prize screen.

claim_prize_ctastring

Call to action text for claiming prize

prize_nft_loyalty_reward_idstring

The id of the Loyalty Reward for completing quest.

prize_point_reward_valuenumber

The point value for completing the quest.

prize_loot_box_idstring

The id of the Loot Box for completing quest.

image_urlstring

The url of the image for the quest.

status'draft' | 'published' | 'archived'

The status of the quest.

quest_requirementsstring[]

An array of quest requirements

Response

Successful response

questobject required

Changes

No recorded changes to this operation across all 1 revision of this API.