Loot box reward choices

Create the reward choice and probabilities for a loot box.

post

Invoke this endpoint to create the reward choice for a loot box and its corresponding probabilities.

Authorizations

Body

titlestringRequired

Title of the loot box reward choice

loot_box_idstringRequired

The Id of the loot box.

subtitlestringOptional

Subtitle of the loot box reward choice

categorystringOptional

Category of the loot box reward choice

point_reward_valuenumberOptional

Point reward value for the loot box

video_urlstringOptional

URL for the video associated with the loot box reward choice (must be less than 100 MB)

quantitynumberOptional

Quantity of the loot box reward choice

reward_uuidstringOptional

UUID of the reward for the loot box reward choice

default_image_urlstringOptional

Default image URL for the loot box reward choice

probability_detailsarrayOptional

Probability details associated with the loot box reward choice

Responses

post

HTTPcURLJavaScriptPython

POST /partner-api/v2/admin/loot_box_reward_choices HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 201

"title='text'&loot_box_id='text'&subtitle='text'&category='text'&point_reward_value=1&video_url='text'&quantity=1&reward_uuid='text'&default_image_url='text'&probability_details=[]"

200

Successful response

{
  "loot_box_reward_choice": {
    "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"
        }
      }
    ]
  }
}

Update a loot box reward choice.

patch

Invoke this endpoint to update the reward choice for a loot box.

Authorizations

Path parameters

loot_box_reward_choice_idstringRequired

The Id of the loot box reward choice.

Body

loot_box_idstringOptional

The Id of the loot box.

titlestringOptional

Title of the loot box reward choice

subtitlestringOptional

Subtitle of the loot box reward choice

categorystringOptional

Category of the loot box reward choice

point_reward_valuenumberOptional

Point reward value for the loot box reward choice

video_urlstringOptional

URL of the video that gives more details about the selected loot box reward

quantitynumberOptional

Quantity of the loot box reward choice

reward_uuidstringOptional

UUID of the reward for the loot box reward choice

default_image_urlstringOptional

Default image URL for the loot box reward choice

probability_detailsarrayOptional

Probability details associated with the loot box reward choice

Responses

patch

HTTPcURLJavaScriptPython

PATCH /partner-api/v2/admin/loot_box_reward_choices/{loot_box_reward_choice_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 201

"loot_box_id='text'&title='text'&subtitle='text'&category='text'&point_reward_value=1&video_url='text'&quantity=1&reward_uuid='text'&default_image_url='text'&probability_details=[]"

200

Successful response

{
  "loot_box_reward_outcome": {
    "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"
        }
      }
    ]
  }
}