Claim activity prize

Claim the prize(s) associated with an Activity.

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

POST/partner-api/opt-ins/{opt_in_id}/claim-activity-prize

Path parameters

opt_in_id*string

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

Body

multipart/form-data

activity_id*string

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

Response

200

Successful response

Body

*/*

prize*object

Request

JavaScriptCurlPython

const response = await fetch('/partner-api/opt-ins/{opt_in_id}/claim-activity-prize', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "activity_id": "text"
    }),
});
const data = await response.json();

Response

200

{
  "prize": {
    "point_reward_value": 0,
    "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": 0,
          "reward_uuid": "text",
          "image": "text",
          "probability": 0,
          "reward": {
            "uuid": "text",
            "name": "text",
            "description": "text",
            "image_url": "text",
            "terms_and_conditions": "text"
          }
        }
      ]
    },
    "reward": {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "image_url": "text",
      "terms_and_conditions": "text"
    }
  }
}