Skip to main content
POST
/
v2
/
offer
curl -X POST \
  'https://api.appcharge.com/v2/offer' \
  -H 'Content-Type: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -d '{
    "publisherOfferId": "progressBar-1",
    "name": "My ProgressBar Offer 1",
    "type": "ProgressBar",
    "active": true,
    "offerExternalUiId": "ProgressBar Design 1", 
    "productsSequence": [
      {
        "index": 1,
        "products": [
          {
            "publisherProductId": "coins",
            "priority": "Main",
            "quantity": 300
          }
        ],
        "priceInUsdCents": 0,
        "barSize": 10
      },
      {
        "index": 2,
        "products": [
          {
            "publisherProductId": "coins",
            "priority": "Main",
            "quantity": 500
          }
        ],
        "priceInUsdCents": 0,
        "barSize": 20
      }
    ],
    "schedule": {
      "permanent": false,
      "timeFrames": [
        {
          "startTime": "2025-11-01T12:05:00.000Z",
          "endTime": "2025-11-22T12:10:00.000Z",
          "notes": "Holiday promotion period."
        }
      ]
    },
    "displayName": "My ProgresBar Offer",
    "description": "This is my progress bar offer description.",
    "segments": [
      "New User",
      "VIP Player"
    ]
  }'
{
  "offerId": "67890abcdef1234567890123",
  "active": true,
  "description": "This is my progress bar offer description.",
  "displayName": "My ProgresBar Offer",
  "name": "My ProgressBar Offer 1",
  "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": 300,
          "priority": "Main",
          "quantityDisplay": "+ 300"
        }
      ],
      "priceInUsdCents": 0,
      "barSize": 10,
      "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": 500,
          "priority": "Main",
          "quantityDisplay": "+ 500"
        }
      ],
      "priceInUsdCents": 0,
      "barSize": 20,
      "id": "67890abcdef1234567890127"
    }
  ],
  "publisherId": "6555b69c02ee8eca00465694",
  "publisherOfferId": "progressBar-1",
  "schedule": {
    "permanent": false,
    "timeFrames": [
      {
        "startTime": "2025-11-01T12:05:00.000Z",
        "endTime": "2025-11-22T12:10:00.000Z",
        "notes": "Holiday promotion period.",
        "id": "67890abcdef1234567890128"
      }
    ]
  },
  "segments": [
    "New User",
    "VIP Player"
  ],
  "createdAt": "2024-11-15T09:30:00.000Z",
  "updatedAt": "2024-11-15T09:30:00.000Z"
}
curl -X POST \
  'https://api.appcharge.com/v2/offer' \
  -H 'Content-Type: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -d '{
    "publisherOfferId": "progressBar-1",
    "name": "My ProgressBar Offer 1",
    "type": "ProgressBar",
    "active": true,
    "offerExternalUiId": "ProgressBar Design 1", 
    "productsSequence": [
      {
        "index": 1,
        "products": [
          {
            "publisherProductId": "coins",
            "priority": "Main",
            "quantity": 300
          }
        ],
        "priceInUsdCents": 0,
        "barSize": 10
      },
      {
        "index": 2,
        "products": [
          {
            "publisherProductId": "coins",
            "priority": "Main",
            "quantity": 500
          }
        ],
        "priceInUsdCents": 0,
        "barSize": 20
      }
    ],
    "schedule": {
      "permanent": false,
      "timeFrames": [
        {
          "startTime": "2025-11-01T12:05:00.000Z",
          "endTime": "2025-11-22T12:10:00.000Z",
          "notes": "Holiday promotion period."
        }
      ]
    },
    "displayName": "My ProgresBar Offer",
    "description": "This is my progress bar offer description.",
    "segments": [
      "New User",
      "VIP Player"
    ]
  }'
{
  "offerId": "67890abcdef1234567890123",
  "active": true,
  "description": "This is my progress bar offer description.",
  "displayName": "My ProgresBar Offer",
  "name": "My ProgressBar Offer 1",
  "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": 300,
          "priority": "Main",
          "quantityDisplay": "+ 300"
        }
      ],
      "priceInUsdCents": 0,
      "barSize": 10,
      "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": 500,
          "priority": "Main",
          "quantityDisplay": "+ 500"
        }
      ],
      "priceInUsdCents": 0,
      "barSize": 20,
      "id": "67890abcdef1234567890127"
    }
  ],
  "publisherId": "6555b69c02ee8eca00465694",
  "publisherOfferId": "progressBar-1",
  "schedule": {
    "permanent": false,
    "timeFrames": [
      {
        "startTime": "2025-11-01T12:05:00.000Z",
        "endTime": "2025-11-22T12:10:00.000Z",
        "notes": "Holiday promotion period.",
        "id": "67890abcdef1234567890128"
      }
    ]
  },
  "segments": [
    "New User",
    "VIP Player"
  ],
  "createdAt": "2024-11-15T09:30:00.000Z",
  "updatedAt": "2024-11-15T09:30:00.000Z"
}

Headers

x-publisher-token
string
required

The publisher token used for authentication.

Body

application/json
publisherOfferId
string
required

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

Example:

"progressBar-1"

name
string
required

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

Example:

"My ProgressBar Offer 1"

type
enum<string>
required

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

Available options:
ProgressBar
Example:

"ProgressBar"

active
boolean
required

Whether the Progress Bar offer is active.

Example:

true

segments
string[]
required

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

If you don't have any segments, pass an empty array.

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

The sequence of products included in the Progress Bar offer.

Min: 1 Max: 50

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 ProgresBar Offer"

description
string

Progress Bar offer description.

Example:

"This is my progress bar offer description."

schedule
object

The schedule for when the Progress Bar offer is available.

Response

Progress Bar offer created 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.