Loot boxes

Endpoint to fetch all loot boxes for a program

get

Authorizations

Query parameters

limitnumberOptional

Amount of loot boxes to return (max 100).

offsetnumberOptional

Index to start at.

Responses

200

Successful response

application/json

get

GET /partner-api/v2/admin/loot-boxes HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "loot_boxes": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "sponsor_name": "text",
      "sponsor_description": "text",
      "recurring_interval_minutes": 1,
      "image_box_together_url": "text",
      "background_gradient_start_color": "text",
      "background_gradient_stop_color": "text",
      "reward_sequence_animation_type": "SHUFFLE",
      "is_sign_up_reward": true,
      "partner_metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "created_at": 1,
      "updated_at": 1,
      "loot_box_reward_choices": [
        {
          "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"
              }
            }
          ]
        }
      ]
    }
  ],
  "total_records": 1
}

Endpoint to create a loot box

post

Authorizations

Body

descriptionstringRequired

Description of the Lootbox object.

namestringRequired

Name/title of the Lootbox object.

sponsor_namestringOptional

Lootbox sponsor name.

sponsor_descriptionstringOptional

Lootbox sponsor description.

recurring_interval_minutesnumberOptional

Interval indicating how often a Lootbox can be granted.

image_box_together_b64stringOptional

Base 64 string of the combined Lootbox image.

image_box_together_urlstringOptional

URL of the combined Lootbox image.

background_gradient_start_colorstringOptional

Hexadecimal color value for the start of the gradient.

background_gradient_stop_colorstringOptional

Hexadecimal color value for the end of the gradient.

reward_sequence_animation_typestringOptional

Animation type dictating how a rewarded Lootbox is presented.

is_sign_up_rewardbooleanOptional

Boolean flag indicating if the Lootbox should be rewarded at signup.

Responses

200

Successful response

application/json

post

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

"description='text'&name='text'&sponsor_name='text'&sponsor_description='text'&recurring_interval_minutes=1&image_box_together_b64='text'&image_box_together_url='text'&background_gradient_start_color='text'&background_gradient_stop_color='text'&reward_sequence_animation_type='text'&is_sign_up_reward=true"

200

Successful response

{
  "loot_box": {
    "id": "text",
    "name": "text",
    "description": "text",
    "sponsor_name": "text",
    "sponsor_description": "text",
    "recurring_interval_minutes": 1,
    "image_box_together_url": "text",
    "background_gradient_start_color": "text",
    "background_gradient_stop_color": "text",
    "reward_sequence_animation_type": "SHUFFLE",
    "is_sign_up_reward": true,
    "partner_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_at": 1,
    "updated_at": 1,
    "loot_box_reward_choices": [
      {
        "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"
            }
          }
        ]
      }
    ]
  }
}

Get the Loot Box with the given ID.

get

Authorizations

Path parameters

loot_box_idstringRequired

the ID of the Loot Box

Responses

200

Successful response

application/json

get

GET /partner-api/v2/admin/loot-boxes/{loot_box_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "loot_box": {
    "id": "text",
    "name": "text",
    "description": "text",
    "sponsor_name": "text",
    "sponsor_description": "text",
    "recurring_interval_minutes": 1,
    "image_box_together_url": "text",
    "background_gradient_start_color": "text",
    "background_gradient_stop_color": "text",
    "reward_sequence_animation_type": "SHUFFLE",
    "is_sign_up_reward": true,
    "partner_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_at": 1,
    "updated_at": 1,
    "loot_box_reward_choices": [
      {
        "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"
            }
          }
        ]
      }
    ]
  }
}

Updates the lootbox with the provided fields.

patch

Authorizations

Path parameters

loot_box_idnumberRequired

Body

descriptionstringRequired

Description of the Lootbox object.

namestringRequired

Name/title of the Lootbox object.

sponsor_namestringOptional

Lootbox sponsor name.

sponsor_descriptionstringOptional

Lootbox sponsor description.

recurring_interval_minutesnumberOptional

Interval indicating how often a Lootbox can be granted.

image_box_together_b64stringOptional

Base 64 string of the combined Lootbox image.

image_box_together_urlstringOptional

URL of the combined Lootbox image.

background_gradient_start_colorstringOptional

Hexadecimal color value for the start of the gradient.

background_gradient_stop_colorstringOptional

Hexadecimal color value for the end of the gradient.

reward_sequence_animation_typestringOptional

Animation type dictating how a rewarded Lootbox is presented.

is_sign_up_rewardbooleanOptional

Boolean flag indicating if the Lootbox should be rewarded at signup.

Responses

200

Successful response

application/json

patch

PATCH /partner-api/v2/admin/loot-boxes/{loot_box_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 328

"description='text'&name='text'&sponsor_name='text'&sponsor_description='text'&recurring_interval_minutes=1&image_box_together_b64='text'&image_box_together_url='text'&background_gradient_start_color='text'&background_gradient_stop_color='text'&reward_sequence_animation_type='text'&is_sign_up_reward=true"

200

Successful response

{
  "loot_box": {
    "id": "text",
    "name": "text",
    "description": "text",
    "sponsor_name": "text",
    "sponsor_description": "text",
    "recurring_interval_minutes": 1,
    "image_box_together_url": "text",
    "background_gradient_start_color": "text",
    "background_gradient_stop_color": "text",
    "reward_sequence_animation_type": "SHUFFLE",
    "is_sign_up_reward": true,
    "partner_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_at": 1,
    "updated_at": 1,
    "loot_box_reward_choices": [
      {
        "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"
            }
          }
        ]
      }
    ]
  }
}

PreviousLoot box reward probabilities NextProgram memberships