Claim quest prize

Claim the prize(s) associated with a Quest.

post

Prizes can exist on both the Quest and Activity levels. Invoke this endpoint to claim the prizes at the Quest level.

Authorizations

Path parameters

opt_in_idanyrequired

the id of the OptIn whose Quest's prize(s) is ready to be claimed.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/opt-ins/{opt_in_id}/claim-quest-prize' \
  --header 'X-API-Key: YOUR_API_KEY'

200

200

{
  "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",
      "container_images": {
        "box_together": "text",
        "box_top": "text",
        "box_bottom": "text"
      },
      "lootbox_reward_choices": [
        {
          "id": "text",
          "title": "text",
          "subtitle": "text",
          "category": "text",
          "point_reward_value": 1,
          "reward_uuid": "text",
          "image": "text",
          "probability": 1,
          "reward": {
            "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"
    }
  }
}

Successful response