Claim activity prize

Claim the prize(s) associated with an Activity.

post

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

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

opt_in_idstringRequired

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

Body

application/x-www-form-urlencoded

activity_idstringRequired

the id of the Activity whose prize(s) you wish to claim

Responses

200

Successful response

application/json

post

/opt-ins/{opt_in_id}/claim-activity-prize

HTTPcURLJavaScriptPython

POST /partner-api/opt-ins/{opt_in_id}/claim-activity-prize HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 22

"activity_id='text'"

200

Successful response

{
  "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"
    }
  }
}