Update Bundle

  curl -X PUT \
  'https://api.appcharge.com/v2/offer/bundle-offer-1' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "My New Bundle Name",
      "type": "Bundle",
      "active": true,
      "segments": [
          "New User"
      ],
      "productsSequence": [
          {
              "index": 1,
              "products": [
                  {
                      "priority": "Sub",
                      "publisherProductId": "123",
                      "quantity": "500",
                  }
              ]
              "priceInUsdCents": 980
          }
      ],
      "productSale": {
          "type": "percentage",
          "sale": 100
      },
      "priceDiscount": {
          "type": "percentage",
          "discount": 20
      },
      "displayName": "My Bundle",
      "description": "This is my bundle description.",
      "offerUiId": "ac77ff889b",
      "offerExternalUiId": "ac22377ff889cc",
      "badges": [
          {
          "publisherBadgeId": "22ac77ff889b"
          }
      ]
      }'

{
  "publisherId": "35nb7861ec9924a6b69a0fe59",
  "offerId": "226cff96123a8717",
  "publisherOfferId": "bundle-offer-1",
  "name": "My New Bundle Name",
  "displayName": "My Bundle",
  "description": "This is my bundle description.",
  "type": "Bundle",
  "active": true,
  "segments": [
      "New User"
  ],
  "publisherTabId": "tab-1",
  "offerUi": {
      "offerUiId": "27e7fb3663e1bfbbf340ffff",
      "active": true,
      "offerUiType": "Bundle",
      "name": "BundOff273",
      "description": "description",
      "backgroundImage": "https://media.appcharge.com/media/65cb7182__4dc30c81-e4aa-40e8-9033-84cb05721bd0",
      "borderColor": {
          "colorOne": "#ffffff",
          "colorTwo": "",
          "direction": ""
      },
      "borderWidth": 2,
      "externalId": "BundOff273"
  },
  "productsSequence": [
      {
          "index": 1,
          "products": [
              {
                  "product": {
                      "publisherProductId": "123",
                      "name": "Coins",
                      "textFontColorHex": "#FFFFFF",
                      "type": "Quantity",
                      "prefix": "",
                      "suffix": "",
                      "priority": "Sub",
                      "images": [
                          {
                              "type": "product",
                              "url": "https://media.appcharge.com/media/45cb7861ec8924a6b69a0f59/download.jpeg"
                          },
                          {
                              "type": "productPrefix",
                              "url": ""
                          }
                      ],
                      "createdAt": "2024-02-14T10:08:17.061Z",
                      "updatedAt": "2024-09-27T13:41:55.775Z",
                      "displayName": "coins",
                      "productId": "65cc91114cf653a9cc2dce2c"
                  },
                  "publisherProductId": "123",
                  "quantity": 500,
                  "priority": "Main"
              }
          ],
          "priceInUsdCents": 980,
          "badges": [],
          "id": "68b4092c7a895e559a3ac8d9"
      }
  ],
  "badges": [
      {
      "publisherBadgeId": "22ac77ff889b"
      }
  ],
  "productSale": {
      "type": "percentage",
      "sale": 100
  },
  "priceDiscount": {
      "type": "percentage",
      "discount": 20
  },
  "createdAt": "2025-04-06T10:00:44.528Z",
  "updatedAt": "2025-06-11T20:00:33.528Z"
}

PUT

offer

{publisherOfferId}

  curl -X PUT \
  'https://api.appcharge.com/v2/offer/bundle-offer-1' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "My New Bundle Name",
      "type": "Bundle",
      "active": true,
      "segments": [
          "New User"
      ],
      "productsSequence": [
          {
              "index": 1,
              "products": [
                  {
                      "priority": "Sub",
                      "publisherProductId": "123",
                      "quantity": "500",
                  }
              ]
              "priceInUsdCents": 980
          }
      ],
      "productSale": {
          "type": "percentage",
          "sale": 100
      },
      "priceDiscount": {
          "type": "percentage",
          "discount": 20
      },
      "displayName": "My Bundle",
      "description": "This is my bundle description.",
      "offerUiId": "ac77ff889b",
      "offerExternalUiId": "ac22377ff889cc",
      "badges": [
          {
          "publisherBadgeId": "22ac77ff889b"
          }
      ]
      }'

{
  "publisherId": "35nb7861ec9924a6b69a0fe59",
  "offerId": "226cff96123a8717",
  "publisherOfferId": "bundle-offer-1",
  "name": "My New Bundle Name",
  "displayName": "My Bundle",
  "description": "This is my bundle description.",
  "type": "Bundle",
  "active": true,
  "segments": [
      "New User"
  ],
  "publisherTabId": "tab-1",
  "offerUi": {
      "offerUiId": "27e7fb3663e1bfbbf340ffff",
      "active": true,
      "offerUiType": "Bundle",
      "name": "BundOff273",
      "description": "description",
      "backgroundImage": "https://media.appcharge.com/media/65cb7182__4dc30c81-e4aa-40e8-9033-84cb05721bd0",
      "borderColor": {
          "colorOne": "#ffffff",
          "colorTwo": "",
          "direction": ""
      },
      "borderWidth": 2,
      "externalId": "BundOff273"
  },
  "productsSequence": [
      {
          "index": 1,
          "products": [
              {
                  "product": {
                      "publisherProductId": "123",
                      "name": "Coins",
                      "textFontColorHex": "#FFFFFF",
                      "type": "Quantity",
                      "prefix": "",
                      "suffix": "",
                      "priority": "Sub",
                      "images": [
                          {
                              "type": "product",
                              "url": "https://media.appcharge.com/media/45cb7861ec8924a6b69a0f59/download.jpeg"
                          },
                          {
                              "type": "productPrefix",
                              "url": ""
                          }
                      ],
                      "createdAt": "2024-02-14T10:08:17.061Z",
                      "updatedAt": "2024-09-27T13:41:55.775Z",
                      "displayName": "coins",
                      "productId": "65cc91114cf653a9cc2dce2c"
                  },
                  "publisherProductId": "123",
                  "quantity": 500,
                  "priority": "Main"
              }
          ],
          "priceInUsdCents": 980,
          "badges": [],
          "id": "68b4092c7a895e559a3ac8d9"
      }
  ],
  "badges": [
      {
      "publisherBadgeId": "22ac77ff889b"
      }
  ],
  "productSale": {
      "type": "percentage",
      "sale": 100
  },
  "priceDiscount": {
      "type": "percentage",
      "discount": 20
  },
  "createdAt": "2025-04-06T10:00:44.528Z",
  "updatedAt": "2025-06-11T20:00:33.528Z"
}

  curl -X PUT \
  'https://api.appcharge.com/v2/offer/bundle-offer-1' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "My New Bundle Name",
      "type": "Bundle",
      "active": true,
      "segments": [
          "New User"
      ],
      "productsSequence": [
          {
              "index": 1,
              "products": [
                  {
                      "priority": "Sub",
                      "publisherProductId": "123",
                      "quantity": "500",
                  }
              ]
              "priceInUsdCents": 980
          }
      ],
      "productSale": {
          "type": "percentage",
          "sale": 100
      },
      "priceDiscount": {
          "type": "percentage",
          "discount": 20
      },
      "displayName": "My Bundle",
      "description": "This is my bundle description.",
      "offerUiId": "ac77ff889b",
      "offerExternalUiId": "ac22377ff889cc",
      "badges": [
          {
          "publisherBadgeId": "22ac77ff889b"
          }
      ]
      }'

{
  "publisherId": "35nb7861ec9924a6b69a0fe59",
  "offerId": "226cff96123a8717",
  "publisherOfferId": "bundle-offer-1",
  "name": "My New Bundle Name",
  "displayName": "My Bundle",
  "description": "This is my bundle description.",
  "type": "Bundle",
  "active": true,
  "segments": [
      "New User"
  ],
  "publisherTabId": "tab-1",
  "offerUi": {
      "offerUiId": "27e7fb3663e1bfbbf340ffff",
      "active": true,
      "offerUiType": "Bundle",
      "name": "BundOff273",
      "description": "description",
      "backgroundImage": "https://media.appcharge.com/media/65cb7182__4dc30c81-e4aa-40e8-9033-84cb05721bd0",
      "borderColor": {
          "colorOne": "#ffffff",
          "colorTwo": "",
          "direction": ""
      },
      "borderWidth": 2,
      "externalId": "BundOff273"
  },
  "productsSequence": [
      {
          "index": 1,
          "products": [
              {
                  "product": {
                      "publisherProductId": "123",
                      "name": "Coins",
                      "textFontColorHex": "#FFFFFF",
                      "type": "Quantity",
                      "prefix": "",
                      "suffix": "",
                      "priority": "Sub",
                      "images": [
                          {
                              "type": "product",
                              "url": "https://media.appcharge.com/media/45cb7861ec8924a6b69a0f59/download.jpeg"
                          },
                          {
                              "type": "productPrefix",
                              "url": ""
                          }
                      ],
                      "createdAt": "2024-02-14T10:08:17.061Z",
                      "updatedAt": "2024-09-27T13:41:55.775Z",
                      "displayName": "coins",
                      "productId": "65cc91114cf653a9cc2dce2c"
                  },
                  "publisherProductId": "123",
                  "quantity": 500,
                  "priority": "Main"
              }
          ],
          "priceInUsdCents": 980,
          "badges": [],
          "id": "68b4092c7a895e559a3ac8d9"
      }
  ],
  "badges": [
      {
      "publisherBadgeId": "22ac77ff889b"
      }
  ],
  "productSale": {
      "type": "percentage",
      "sale": 100
  },
  "priceDiscount": {
      "type": "percentage",
      "discount": 20
  },
  "createdAt": "2025-04-06T10:00:44.528Z",
  "updatedAt": "2025-06-11T20:00:33.528Z"
}

Headers

x-publisher-token

string

required

The publisher token used for authentication.

Path Parameters

publisherOfferId

string

required

The bundle offer ID provided by the publisher. This is the offer's External ID value in the Publisher Dashboard.

Body

application/json

name

string

required

The name of the bundle (at least 3 characters).

type

enum<string>

required

The type of offer - In this case 'Bundle'.

Available options:

Bundle

active

boolean

required

Whether the bundle is active.

segments

string[]

required

List of player segments that this bundle applies to (e.g., ["NewUser", "BigSpender"]).

productsSequence

object[]

required

The sequence of products included in the bundle.

Show child attributes

productsSequence.index

integer

The order of the product in the bundle.

productsSequence.products

object[]

List of products in the bundle.

Show child attributes

productsSequence.products.priority

string

required

Specifies the display priority of a product within the bundle. Either Main or Sub.

productsSequence.products.publisherProductId

string

The unique ID of the product.

productsSequence.products.quantity

integer

The quantity of the product in the bundle.

productsSequence.priceInUsdCents

integer

The price of the product in cents. The value must be either 0 (free), or by minimum 80 cents.

displayName

string

If not specified, the bundle name will be used.

description

string

The description of the offer (conditionally returned).

offerUiId

string

Internal ID for the Offer UI (required if offerExternalUiId not provided).

offerExternalUiId

string

The external UI ID for the bundle.

publisherSectionId

string

The publisher section ID.

publisherTabId

string

Tab ID in the web store.

badges

object[]

List of badges associated with the bundle.

Show child attributes

badges.publisherBadgeId

string

The ID as configured in the dashboard.

productSale

object

Sale details for products in the bundle. The sale will only be applied on the first product.

Show child attributes

productSale.sale

integer

The sale percentage applied to the product quantity.

productSale.type

enum<string>

default:percentage

The type of sale.

Available options:

percentage,

multiplier,

fixed_amount

priceDiscount

object

Discount applied to the bundle price.

Show child attributes

priceDiscount.discount

integer

The discount percentage applied.

priceDiscount.type

enum<string>

default:percentage

The type of discount applied.

Available options:

percentage

Response

Bundle updated successfully.

publisherId

string

Publisher ID.

offerId

string

The unique identifier of the bundle.

publisherOfferId

string

The bundle offer ID provided by the publisher. This is the offer's External ID value in the Publisher Dashboard.

name

string

The name of the bundle.

displayName

string

The display name of the bundle.

description

string

The description of the offer (conditionally returned).

type

string

The type of offer.

active

boolean

Whether the bundle is active.

segments

string[]

List of player segments that this bundle applies to (e.g., ["NewUser", "BigSpender"]).

publisherTabId

string

Tab ID in the web store.

offerUi

object

Details on the bundle design, as configured in the Publisher Dashboard.

Show child attributes

offerUi.offerUiId

string

The ID of the bundle design, as displayed in the Publisher Dashboard.

offerUi.externalId

string

The SKU of the bundle design, as defined in the Publisher Dashboard.

offerUi.active

boolean

Whether the bundle design is active.

offerUi.offerUiType

string

The type of offer design. In this case, ‘bundle’.

offerUi.name

string

The name of the bundle design, as defined in the Publisher Dashboard.

offerUi.description

string

The description of the bundle design, as defined in the Publisher Dashboard.

offerUi.backgroundImage

string

The background image of the bundle design, as defined in the Publisher Dashboard.

offerUi.specialOffer

object

Details on the bundle template and design.

Show child attributes

offerUi.specialOffer.templateType

string

The template type, as configured in the Publisher Dashboard.

offerUi.specialOffer.title

string

The title of the bundle, as configured in the Publisher Dashboard.

offerUi.specialOffer.fontSize

number

The font size of the bundle title, as configured in the Publisher Dashboard.

offerUi.specialOffer.fontWeight

string

The font weight of the bundle title, as configured in the Publisher Dashboard.

offerUi.specialOffer.fontColor

object

Details on the font color of the bundle title as configured in the Publisher Dashboard. If the font color is set to linear, both 'colorOne' and 'colorTwo' will be returned. 'colorThree' may also be returned, if configured.

Show child attributes

offerUi.specialOffer.fontColor.colorOne

string

The font color of the bundle title.

offerUi.specialOffer.fontColor.colorTwo

string

The second font color of the bundle title. Relevant only if the font color is set to linear.

offerUi.specialOffer.fontColor.colorThree

string

The third font color of the bundle title. Relevant only if the font color is set to linear.

offerUi.specialOffer.backgroundColor

object

Details on the background color of the bundle title as configured in the Publisher Dashboard. If the background color is set to linear, the direction will be returned along with ‘colorOne’ and ‘colorTwo’.

Show child attributes

offerUi.specialOffer.backgroundColor.colorOne

string

The background color of the bundle title.

offerUi.specialOffer.backgroundColor.colorTwo

string

The second background color of the bundle title. Relevant only if the background color is set to linear.

offerUi.specialOffer.backgroundColor.direction

string

The direction of the linear gradient. Relevant only if the background color is set to linear.

productsSequence

object[]

A sequence of products in the bundle.

Show child attributes

productsSequence.index

integer

The order of the product in the bundle.

productsSequence.products

object[]

List of products in the bundle.

Show child attributes

productsSequence.products.publisherProductId

string

The unique ID of the product.

productsSequence.products.quantity

integer

The quantity of the product in the bundle.

productsSequence.products.priority

string

Specifies the display priority of a product within the bundle. Either Main or Sub.

productsSequence.priceInUsdCents

integer

The price of the product in cents. The value must be either 0 (free), or by minimum 80 cents.

badges

object[]

List of badges associated with the bundle

Show child attributes

badges.publisherBadgeId

string

The ID as configured in the dashboard.

productSale

object

Sale details for products in the bundle. The sale will only be applied on the first product.

Show child attributes

productSale.sale

integer

The sale percentage applied to the product quanitity.

productSale.type

string

The type of sale.

priceDiscount

object

Discount applied to the special offer price.

Show child attributes

priceDiscount.discount

integer

The discount percentage applied.

priceDiscount.type

string

The type of discount applied.

createdAt

string<date-time>

Date the bundle was created.

updatedAt

string<date-time>

Date the bundle was updated.

Create Bundle Introduction

⌘I

Overview

What's New

Web Store

Checkout

Media

Events Center

Translations

Headers

Path Parameters

Body

Response