Skip to main content
PUT
/
v2
/
offer
/
$
{publisherOfferId}
curl -X PUT \
  'https://api.appcharge.com/v2/offer/progressBar-1' \
  -H 'Content-Type: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -d '{
    "name": "My Updated ProgressBar Offer",
    "type": "ProgressBar",
    "active": false
  }'

{
  "offerId": "67890abcdef1234567890123",
  "active": false,
  "description": "This is my updated progress bar offer description.",
  "displayName": "My Updated ProgressBar Offer",
  "name": "My Updated ProgressBar Offer",
  "type": "ProgressBar",
  "offerUi": {
    "offerUiId": "67890abcdef1234567890124",
    "active": true,
    "offerUiType": "ProgressBar",
    "name": "ProgressBar Design 1",
    "description": "Progress Bar UI design template",
    "backgroundImage": "https://media-dev.appcharge.com/media/6555b69c02ee8eca00465694/background-image.png",
    "progressBar": {
      "barFillColor": {
        "colorOne": "#FFD450",
        "colorTwo": "#EDB923",
        "gradientDirection": "to bottom"
      },
      "barRadius": 12,
      "accumulatedItem": {
        "imageUrl": "https://media-dev.appcharge.com/media/6555b69c02ee8eca00465694/pngtree-game-three-stars-png-image_4524815.jpeg",
        "backgroundColor": {
          "colorOne": "#FFD450",
          "colorTwo": "#EDB923",
          "gradientDirection": "to right"
        }
      },
      "backgroundOpacity": 80,
      "frameRadius": 12
    },
    "borderColor": {
      "colorOne": "#DBBD9C",
      "colorTwo": "#DBBD9C",
      "gradientDirection": "to right"
    },
    "backgroundColor": {
      "colorOne": "#DABA98",
      "colorTwo": "#FDFCF9",
      "gradientDirection": "to right"
    },
    "borderWidth": 3,
    "externalId": "ProgressBar 1"
  },
  "productsSequence": [
    {
      "index": 1,
      "products": [
        {
          "product": {
            "publisherProductId": "coins",
            "name": "coins",
            "textFontColorHex": "#cb1010",
            "type": "Quantity",
            "prefix": "+",
            "suffix": "",
            "priority": "Main",
            "images": [
              {
                "type": "product",
                "url": "https://media-dev.appcharge.com/media/63e53f149e43bf44513e15c3/asset.png"
              },
              {
                "type": "productPrefix",
                "url": "https://media-dev.appcharge.com/media/63e53f149e43bf44513e15c3/prefix-icon.png"
              }
            ],
            "createdAt": "2024-01-15T10:30:00.000Z",
            "updatedAt": "2024-11-20T14:22:00.000Z",
            "displayName": "Coins",
            "description": "In-game currency used for purchases.",
            "productId": "67890abcdef1234567890125"
          },
          "publisherProductId": "coins",
          "quantity": 400,
          "priority": "Main",
          "quantityDisplay": "+ 400"
        }
      ],
      "priceInUsdCents": 0,
      "barSize": 15,
      "id": "67890abcdef1234567890126"
    },
    {
      "index": 2,
      "products": [
        {
          "product": {
            "publisherProductId": "coins",
            "name": "coins",
            "textFontColorHex": "#cb1010",
            "type": "Quantity",
            "prefix": "+",
            "suffix": "",
            "priority": "Main",
            "images": [
              {
                "type": "product",
                "url": "https://media-dev.appcharge.com/media/63e53f149e43bf44513e15c3/asset.png"
              },
              {
                "type": "productPrefix",
                "url": "https://media-dev.appcharge.com/media/63e53f149e43bf44513e15c3/prefix-icon.png"
              }
            ],
            "createdAt": "2024-01-15T10:30:00.000Z",
            "updatedAt": "2024-11-20T14:22:00.000Z",
            "displayName": "Coins",
            "description": "In-game currency used for purchases.",
            "productId": "67890abcdef1234567890125"
          },
          "publisherProductId": "coins",
          "quantity": 600,
          "priority": "Main",
          "quantityDisplay": "+ 600"
        }
      ],
      "priceInUsdCents": 0,
      "barSize": 25,
      "id": "67890abcdef1234567890127"
    }
  ],
  "publisherId": "6555b69c02ee8eca00465694",
  "publisherOfferId": "progressBar-1",
  "schedule": {
    "permanent": false,
    "timeFrames": [
      {
        "startTime": "2025-12-01T12:05:00.000Z",
        "endTime": "2025-12-22T12:10:00.000Z",
        "notes": "Updated holiday promotion period.",
        "id": "67890abcdef1234567890128"
      }
    ]
  },
  "segments": [
    "New User",
    "VIP Player"
  ],
  "createdAt": "2024-11-15T09:30:00.000Z",
  "updatedAt": "2024-12-01T10:15:00.000Z"
}

curl -X PUT \
  'https://api.appcharge.com/v2/offer/progressBar-1' \
  -H 'Content-Type: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -d '{
    "name": "My Updated ProgressBar Offer",
    "type": "ProgressBar",
    "active": false
  }'

{
  "offerId": "67890abcdef1234567890123",
  "active": false,
  "description": "This is my updated progress bar offer description.",
  "displayName": "My Updated ProgressBar Offer",
  "name": "My Updated ProgressBar Offer",
  "type": "ProgressBar",
  "offerUi": {
    "offerUiId": "67890abcdef1234567890124",
    "active": true,
    "offerUiType": "ProgressBar",
    "name": "ProgressBar Design 1",
    "description": "Progress Bar UI design template",
    "backgroundImage": "https://media-dev.appcharge.com/media/6555b69c02ee8eca00465694/background-image.png",
    "progressBar": {
      "barFillColor": {
        "colorOne": "#FFD450",
        "colorTwo": "#EDB923",
        "gradientDirection": "to bottom"
      },
      "barRadius": 12,
      "accumulatedItem": {
        "imageUrl": "https://media-dev.appcharge.com/media/6555b69c02ee8eca00465694/pngtree-game-three-stars-png-image_4524815.jpeg",
        "backgroundColor": {
          "colorOne": "#FFD450",
          "colorTwo": "#EDB923",
          "gradientDirection": "to right"
        }
      },
      "backgroundOpacity": 80,
      "frameRadius": 12
    },
    "borderColor": {
      "colorOne": "#DBBD9C",
      "colorTwo": "#DBBD9C",
      "gradientDirection": "to right"
    },
    "backgroundColor": {
      "colorOne": "#DABA98",
      "colorTwo": "#FDFCF9",
      "gradientDirection": "to right"
    },
    "borderWidth": 3,
    "externalId": "ProgressBar 1"
  },
  "productsSequence": [
    {
      "index": 1,
      "products": [
        {
          "product": {
            "publisherProductId": "coins",
            "name": "coins",
            "textFontColorHex": "#cb1010",
            "type": "Quantity",
            "prefix": "+",
            "suffix": "",
            "priority": "Main",
            "images": [
              {
                "type": "product",
                "url": "https://media-dev.appcharge.com/media/63e53f149e43bf44513e15c3/asset.png"
              },
              {
                "type": "productPrefix",
                "url": "https://media-dev.appcharge.com/media/63e53f149e43bf44513e15c3/prefix-icon.png"
              }
            ],
            "createdAt": "2024-01-15T10:30:00.000Z",
            "updatedAt": "2024-11-20T14:22:00.000Z",
            "displayName": "Coins",
            "description": "In-game currency used for purchases.",
            "productId": "67890abcdef1234567890125"
          },
          "publisherProductId": "coins",
          "quantity": 400,
          "priority": "Main",
          "quantityDisplay": "+ 400"
        }
      ],
      "priceInUsdCents": 0,
      "barSize": 15,
      "id": "67890abcdef1234567890126"
    },
    {
      "index": 2,
      "products": [
        {
          "product": {
            "publisherProductId": "coins",
            "name": "coins",
            "textFontColorHex": "#cb1010",
            "type": "Quantity",
            "prefix": "+",
            "suffix": "",
            "priority": "Main",
            "images": [
              {
                "type": "product",
                "url": "https://media-dev.appcharge.com/media/63e53f149e43bf44513e15c3/asset.png"
              },
              {
                "type": "productPrefix",
                "url": "https://media-dev.appcharge.com/media/63e53f149e43bf44513e15c3/prefix-icon.png"
              }
            ],
            "createdAt": "2024-01-15T10:30:00.000Z",
            "updatedAt": "2024-11-20T14:22:00.000Z",
            "displayName": "Coins",
            "description": "In-game currency used for purchases.",
            "productId": "67890abcdef1234567890125"
          },
          "publisherProductId": "coins",
          "quantity": 600,
          "priority": "Main",
          "quantityDisplay": "+ 600"
        }
      ],
      "priceInUsdCents": 0,
      "barSize": 25,
      "id": "67890abcdef1234567890127"
    }
  ],
  "publisherId": "6555b69c02ee8eca00465694",
  "publisherOfferId": "progressBar-1",
  "schedule": {
    "permanent": false,
    "timeFrames": [
      {
        "startTime": "2025-12-01T12:05:00.000Z",
        "endTime": "2025-12-22T12:10:00.000Z",
        "notes": "Updated holiday promotion period.",
        "id": "67890abcdef1234567890128"
      }
    ]
  },
  "segments": [
    "New User",
    "VIP Player"
  ],
  "createdAt": "2024-11-15T09:30:00.000Z",
  "updatedAt": "2024-12-01T10:15:00.000Z"
}

Headers

​
x-publisher-token
string
required

The publisher token used for authentication.

Path Parameters

​
publisherOfferId
string
required

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

Body

application/json
​
type
enum<string>
required

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

Available options:
ProgressBar
Example:

"ProgressBar"

​
name
string

The name of the Progress Bar offer (at least 3 characters).

Example:

"My Updated ProgressBar Offer"

​
active
boolean

Whether the Progress Bar offer is active.

Example:

false

​
offerUiId
string

Internal ID of the offer design. Required if offerExternalUiId is not provided.

Example:

"67890abcdef1234567890124"

​
offerExternalUiId
string

The offer design ID. This is the Offer Design's External ID value in the Publisher Dashboard. Required if offerUiId is not provided.

Example:

"ProgressBar Design 1"

​
displayName
string

The display name of the Progress Bar offer shown to players.

Example:

"My Updated ProgressBar Offer"

​
description
string

The description of the Progress Bar offer.

Example:

"This is my updated progress bar offer description."

​
segments
string[]

List of player segments that this Progress Bar offer applies to.

Example:
["New User", "VIP Player"]
​
productsSequence
object[]

The sequence of products included in the Progress Bar offer.

Min: 1 Max: 50

​
schedule
object

The schedule for when the Progress Bar offer is available.

Response

Progress Bar offer updated successfully.

​
publisherId
string

Publisher ID.

​
offerId
string

Autogenerated Progress Bar offer ID.

​
publisherOfferId
string

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

​
name
string

Progress Bar offer name.

​
displayName
string

Progress Bar offer display name that is shown to players.

​
description
string

Progress Bar offer description.

​
type
string

Offer type.

Example:

"ProgressBar"

​
active
boolean

Whether the Progress Bar offer is active.

​
segments
string[]

The player segments associated with the Progress Bar offer.

​
offerUi
object

Information about the Progress Bar offer design, as configured in the Publisher Dashboard.

​
productsSequence
object[]

The sequence of missions within the Progress Bar offer

​
schedule
object

The schedule for when the Progress Bar offer is available.

​
createdAt
string<date-time>

Date the Progress Bar offer was created.

​
updatedAt
string<date-time>

Date the Progress Bar offer was last updated.