curl -X POST \
'https://api.appcharge.com/v2/offer' \
-H 'Content-Type: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
-d '{
"publisherOfferId": "progressBar-single-1",
"name": "My Classic Progress Bar",
"type": "ProgressBar",
"active": true,
"offerExternalUiId": "progress-bar-design-single",
"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 Classic Progress Bar",
"description": "A progress bar with sequential missions.",
"segments": [
"New User",
"VIP Player"
]
}'
curl -X POST \
'https://api.appcharge.com/v2/offer' \
-H 'Content-Type: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
-d '{
"publisherOfferId": "progressBar-milestones-1",
"name": "My Milestone Progress Bar",
"type": "ProgressBar",
"active": true,
"offerExternalUiId": "progress-bar-design-milestones",
"productsSequence": [
{
"index": 1,
"products": [
{
"publisherProductId": "coins",
"priority": "Main",
"quantity": 300
},
{
"publisherProductId": "gems",
"priority": "Sub",
"quantity": 50
}
],
"priceInUsdCents": 0,
"barSize": 10
},
{
"index": 2,
"products": [
{
"publisherProductId": "coins",
"priority": "Main",
"quantity": 500
},
{
"publisherProductId": "gems",
"priority": "Sub",
"quantity": 100
}
],
"priceInUsdCents": 0,
"barSize": 20
},
{
"index": 3,
"products": [
{
"publisherProductId": "coins",
"priority": "Main",
"quantity": 1000
},
{
"publisherProductId": "gems",
"priority": "Sub",
"quantity": 250
},
{
"publisherProductId": "energy",
"priority": "Sub",
"quantity": 100
}
],
"priceInUsdCents": 0,
"barSize": 30
}
],
"schedule": {
"permanent": false,
"timeFrames": [
{
"startTime": "2025-11-01T12:05:00.000Z",
"endTime": "2025-11-22T12:10:00.000Z",
"notes": "Holiday promotion period."
}
]
},
"displayName": "My Milestone Progress Bar",
"description": "A progress bar with all milestones visible at once.",
"segments": [
"New User",
"VIP Player"
]
}'
{
"offerId": "67890abcdef1234567890123",
"active": true,
"description": "A progress bar with sequential missions.",
"displayName": "My Classic Progress Bar",
"name": "My Classic Progress Bar",
"type": "ProgressBar",
"offerUi": {
"id": "67890abcdef1234567890124",
"offerUiType": "ProgressBar",
"name": "Classic Progress Bar Design",
"description": "Progress Bar UI design template",
"backgroundImageUrl": "https://media-dev.appcharge.com/media/6555b69c02ee8eca00465694/background-image.png",
"title": {
"text": "Mission impossible!",
"fontColor": "#FFD700",
"fontSize": 10,
"fontWeight": "bold"
},
"subtitle": {
"text": "To infinity and beyond!",
"fontColor": "#FFD700",
"fontSize": 8,
"fontWeight": "normal"
},
"progressBar": {
"barFillColor": {
"colorOne": "#FFD450",
"colorTwo": "#EDB923",
"gradientDirection": "to bottom"
},
"barRadius": 12,
"accumulatedItem": {
"imageUrl": "https://media-dev.appcharge.com/media/6555b69c02ee8eca00465694/item.jpeg",
"ribbonImageUrl": "https://plus.unsplash.com/premium_photo-1681400545953-0ba00cfa7926?q=80&w=880&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D"
},
"backgroundOpacity": 80,
"frameRadius": 12
},
"borderColor": {
"colorOne": "#DBBD9C",
"colorTwo": "#DBBD9C",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#DABA98",
"colorTwo": "#FDFCF9",
"gradientDirection": "to right"
},
"borderWidth": 3,
"externalId": "progress-bar-design-single"
},
"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"
}
],
"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"
}
],
"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-single-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"
}
{
"offerId": "67890abcdef1234567890200",
"active": true,
"description": "A progress bar with all milestones visible at once.",
"displayName": "My Milestone Progress Bar",
"name": "My Milestone Progress Bar",
"type": "ProgressBar",
"offerUi": {
"id": "67890abcdef1234567890201",
"offerUiType": "ProgressBar",
"name": "Milestone Progress Bar Design",
"description": "Milestone Progress Bar UI design template",
"backgroundImageUrl": "https://media-dev.appcharge.com/media/6555b69c02ee8eca00465694/background-image.png",
"title": {
"text": "Reach Every Milestone",
"fontColor": "#FFD700",
"fontSize": 10,
"fontWeight": "bold"
},
"subtitle": {
"text": "Collect rewards along the way",
"fontColor": "#FFD700",
"fontSize": 8,
"fontWeight": "normal"
},
"progressBar": {
"barFillColor": {
"colorOne": "#FFD450",
"colorTwo": "#EDB923",
"gradientDirection": "to bottom"
},
"barRadius": 12,
"accumulatedItem": {
"imageUrl": "https://media-dev.appcharge.com/media/6555b69c02ee8eca00465694/item.jpeg",
"ribbonImageUrl": "https://plus.unsplash.com/premium_photo-1681400545953-0ba00cfa7926?q=80&w=880&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D"
},
"headerImageUrl": "https://plus.unsplash.com/premium_photo-1785080652560-f334e6ea704c?q=80&w=687&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
"backgroundColor": {
"colorOne": "#dde9f4",
"colorTwo": "#f66578",
"gradientDirection": "to bottom"
},
"textColor": "#FFD700",
"backgroundOpacity": 80,
"frameRadius": 12,
"type": "milestones",
"milestones": {
"milestoneCompletedIconUrl": "https://plus.unsplash.com/premium_photo-1681400545953-0ba00cfa7926?q=80&w=880&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
"tooltipBackgroundColor": "#1f9eec"
}
},
"borderColor": {
"colorOne": "#DBBD9C",
"colorTwo": "#DBBD9C",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#DABA98",
"colorTwo": "#FDFCF9",
"gradientDirection": "to right"
},
"borderWidth": 3,
"externalId": "progress-bar-design-milestones"
},
"productsSequence": [
{
"index": 1,
"products": [
{
"publisherProductId": "coins",
"quantity": 300,
"priority": "Main",
"quantityDisplay": "+ 300"
},
{
"publisherProductId": "gems",
"quantity": 50,
"priority": "Sub",
"quantityDisplay": "+ 50"
}
],
"priceInUsdCents": 0,
"barSize": 10,
"id": "67890abcdef1234567890202"
},
{
"index": 2,
"products": [
{
"publisherProductId": "coins",
"quantity": 500,
"priority": "Main",
"quantityDisplay": "+ 500"
},
{
"publisherProductId": "gems",
"quantity": 100,
"priority": "Sub",
"quantityDisplay": "+ 100"
}
],
"priceInUsdCents": 0,
"barSize": 20,
"id": "67890abcdef1234567890203"
},
{
"index": 3,
"products": [
{
"publisherProductId": "coins",
"quantity": 1000,
"priority": "Main",
"quantityDisplay": "+ 1000"
},
{
"publisherProductId": "gems",
"quantity": 250,
"priority": "Sub",
"quantityDisplay": "+ 250"
},
{
"publisherProductId": "energy",
"quantity": 100,
"priority": "Sub",
"quantityDisplay": "+ 100"
}
],
"priceInUsdCents": 0,
"barSize": 30,
"id": "67890abcdef1234567890204"
}
],
"publisherId": "6555b69c02ee8eca00465694",
"publisherOfferId": "progressBar-milestones-1",
"schedule": {
"permanent": false,
"timeFrames": [
{
"startTime": "2025-11-01T12:05:00.000Z",
"endTime": "2025-11-22T12:10:00.000Z",
"notes": "Holiday promotion period.",
"id": "67890abcdef1234567890205"
}
]
},
"segments": [
"New User",
"VIP Player"
],
"createdAt": "2024-11-15T09:30:00.000Z",
"updatedAt": "2024-11-15T09:30:00.000Z"
}
Progress Bars
Create Progress Bar
Creates a Progress Bar offer.
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-single-1",
"name": "My Classic Progress Bar",
"type": "ProgressBar",
"active": true,
"offerExternalUiId": "progress-bar-design-single",
"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 Classic Progress Bar",
"description": "A progress bar with sequential missions.",
"segments": [
"New User",
"VIP Player"
]
}'
curl -X POST \
'https://api.appcharge.com/v2/offer' \
-H 'Content-Type: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
-d '{
"publisherOfferId": "progressBar-milestones-1",
"name": "My Milestone Progress Bar",
"type": "ProgressBar",
"active": true,
"offerExternalUiId": "progress-bar-design-milestones",
"productsSequence": [
{
"index": 1,
"products": [
{
"publisherProductId": "coins",
"priority": "Main",
"quantity": 300
},
{
"publisherProductId": "gems",
"priority": "Sub",
"quantity": 50
}
],
"priceInUsdCents": 0,
"barSize": 10
},
{
"index": 2,
"products": [
{
"publisherProductId": "coins",
"priority": "Main",
"quantity": 500
},
{
"publisherProductId": "gems",
"priority": "Sub",
"quantity": 100
}
],
"priceInUsdCents": 0,
"barSize": 20
},
{
"index": 3,
"products": [
{
"publisherProductId": "coins",
"priority": "Main",
"quantity": 1000
},
{
"publisherProductId": "gems",
"priority": "Sub",
"quantity": 250
},
{
"publisherProductId": "energy",
"priority": "Sub",
"quantity": 100
}
],
"priceInUsdCents": 0,
"barSize": 30
}
],
"schedule": {
"permanent": false,
"timeFrames": [
{
"startTime": "2025-11-01T12:05:00.000Z",
"endTime": "2025-11-22T12:10:00.000Z",
"notes": "Holiday promotion period."
}
]
},
"displayName": "My Milestone Progress Bar",
"description": "A progress bar with all milestones visible at once.",
"segments": [
"New User",
"VIP Player"
]
}'
{
"offerId": "67890abcdef1234567890123",
"active": true,
"description": "A progress bar with sequential missions.",
"displayName": "My Classic Progress Bar",
"name": "My Classic Progress Bar",
"type": "ProgressBar",
"offerUi": {
"id": "67890abcdef1234567890124",
"offerUiType": "ProgressBar",
"name": "Classic Progress Bar Design",
"description": "Progress Bar UI design template",
"backgroundImageUrl": "https://media-dev.appcharge.com/media/6555b69c02ee8eca00465694/background-image.png",
"title": {
"text": "Mission impossible!",
"fontColor": "#FFD700",
"fontSize": 10,
"fontWeight": "bold"
},
"subtitle": {
"text": "To infinity and beyond!",
"fontColor": "#FFD700",
"fontSize": 8,
"fontWeight": "normal"
},
"progressBar": {
"barFillColor": {
"colorOne": "#FFD450",
"colorTwo": "#EDB923",
"gradientDirection": "to bottom"
},
"barRadius": 12,
"accumulatedItem": {
"imageUrl": "https://media-dev.appcharge.com/media/6555b69c02ee8eca00465694/item.jpeg",
"ribbonImageUrl": "https://plus.unsplash.com/premium_photo-1681400545953-0ba00cfa7926?q=80&w=880&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D"
},
"backgroundOpacity": 80,
"frameRadius": 12
},
"borderColor": {
"colorOne": "#DBBD9C",
"colorTwo": "#DBBD9C",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#DABA98",
"colorTwo": "#FDFCF9",
"gradientDirection": "to right"
},
"borderWidth": 3,
"externalId": "progress-bar-design-single"
},
"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"
}
],
"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"
}
],
"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-single-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"
}
{
"offerId": "67890abcdef1234567890200",
"active": true,
"description": "A progress bar with all milestones visible at once.",
"displayName": "My Milestone Progress Bar",
"name": "My Milestone Progress Bar",
"type": "ProgressBar",
"offerUi": {
"id": "67890abcdef1234567890201",
"offerUiType": "ProgressBar",
"name": "Milestone Progress Bar Design",
"description": "Milestone Progress Bar UI design template",
"backgroundImageUrl": "https://media-dev.appcharge.com/media/6555b69c02ee8eca00465694/background-image.png",
"title": {
"text": "Reach Every Milestone",
"fontColor": "#FFD700",
"fontSize": 10,
"fontWeight": "bold"
},
"subtitle": {
"text": "Collect rewards along the way",
"fontColor": "#FFD700",
"fontSize": 8,
"fontWeight": "normal"
},
"progressBar": {
"barFillColor": {
"colorOne": "#FFD450",
"colorTwo": "#EDB923",
"gradientDirection": "to bottom"
},
"barRadius": 12,
"accumulatedItem": {
"imageUrl": "https://media-dev.appcharge.com/media/6555b69c02ee8eca00465694/item.jpeg",
"ribbonImageUrl": "https://plus.unsplash.com/premium_photo-1681400545953-0ba00cfa7926?q=80&w=880&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D"
},
"headerImageUrl": "https://plus.unsplash.com/premium_photo-1785080652560-f334e6ea704c?q=80&w=687&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
"backgroundColor": {
"colorOne": "#dde9f4",
"colorTwo": "#f66578",
"gradientDirection": "to bottom"
},
"textColor": "#FFD700",
"backgroundOpacity": 80,
"frameRadius": 12,
"type": "milestones",
"milestones": {
"milestoneCompletedIconUrl": "https://plus.unsplash.com/premium_photo-1681400545953-0ba00cfa7926?q=80&w=880&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
"tooltipBackgroundColor": "#1f9eec"
}
},
"borderColor": {
"colorOne": "#DBBD9C",
"colorTwo": "#DBBD9C",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#DABA98",
"colorTwo": "#FDFCF9",
"gradientDirection": "to right"
},
"borderWidth": 3,
"externalId": "progress-bar-design-milestones"
},
"productsSequence": [
{
"index": 1,
"products": [
{
"publisherProductId": "coins",
"quantity": 300,
"priority": "Main",
"quantityDisplay": "+ 300"
},
{
"publisherProductId": "gems",
"quantity": 50,
"priority": "Sub",
"quantityDisplay": "+ 50"
}
],
"priceInUsdCents": 0,
"barSize": 10,
"id": "67890abcdef1234567890202"
},
{
"index": 2,
"products": [
{
"publisherProductId": "coins",
"quantity": 500,
"priority": "Main",
"quantityDisplay": "+ 500"
},
{
"publisherProductId": "gems",
"quantity": 100,
"priority": "Sub",
"quantityDisplay": "+ 100"
}
],
"priceInUsdCents": 0,
"barSize": 20,
"id": "67890abcdef1234567890203"
},
{
"index": 3,
"products": [
{
"publisherProductId": "coins",
"quantity": 1000,
"priority": "Main",
"quantityDisplay": "+ 1000"
},
{
"publisherProductId": "gems",
"quantity": 250,
"priority": "Sub",
"quantityDisplay": "+ 250"
},
{
"publisherProductId": "energy",
"quantity": 100,
"priority": "Sub",
"quantityDisplay": "+ 100"
}
],
"priceInUsdCents": 0,
"barSize": 30,
"id": "67890abcdef1234567890204"
}
],
"publisherId": "6555b69c02ee8eca00465694",
"publisherOfferId": "progressBar-milestones-1",
"schedule": {
"permanent": false,
"timeFrames": [
{
"startTime": "2025-11-01T12:05:00.000Z",
"endTime": "2025-11-22T12:10:00.000Z",
"notes": "Holiday promotion period.",
"id": "67890abcdef1234567890205"
}
]
},
"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-single-1",
"name": "My Classic Progress Bar",
"type": "ProgressBar",
"active": true,
"offerExternalUiId": "progress-bar-design-single",
"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 Classic Progress Bar",
"description": "A progress bar with sequential missions.",
"segments": [
"New User",
"VIP Player"
]
}'
curl -X POST \
'https://api.appcharge.com/v2/offer' \
-H 'Content-Type: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
-d '{
"publisherOfferId": "progressBar-milestones-1",
"name": "My Milestone Progress Bar",
"type": "ProgressBar",
"active": true,
"offerExternalUiId": "progress-bar-design-milestones",
"productsSequence": [
{
"index": 1,
"products": [
{
"publisherProductId": "coins",
"priority": "Main",
"quantity": 300
},
{
"publisherProductId": "gems",
"priority": "Sub",
"quantity": 50
}
],
"priceInUsdCents": 0,
"barSize": 10
},
{
"index": 2,
"products": [
{
"publisherProductId": "coins",
"priority": "Main",
"quantity": 500
},
{
"publisherProductId": "gems",
"priority": "Sub",
"quantity": 100
}
],
"priceInUsdCents": 0,
"barSize": 20
},
{
"index": 3,
"products": [
{
"publisherProductId": "coins",
"priority": "Main",
"quantity": 1000
},
{
"publisherProductId": "gems",
"priority": "Sub",
"quantity": 250
},
{
"publisherProductId": "energy",
"priority": "Sub",
"quantity": 100
}
],
"priceInUsdCents": 0,
"barSize": 30
}
],
"schedule": {
"permanent": false,
"timeFrames": [
{
"startTime": "2025-11-01T12:05:00.000Z",
"endTime": "2025-11-22T12:10:00.000Z",
"notes": "Holiday promotion period."
}
]
},
"displayName": "My Milestone Progress Bar",
"description": "A progress bar with all milestones visible at once.",
"segments": [
"New User",
"VIP Player"
]
}'
{
"offerId": "67890abcdef1234567890123",
"active": true,
"description": "A progress bar with sequential missions.",
"displayName": "My Classic Progress Bar",
"name": "My Classic Progress Bar",
"type": "ProgressBar",
"offerUi": {
"id": "67890abcdef1234567890124",
"offerUiType": "ProgressBar",
"name": "Classic Progress Bar Design",
"description": "Progress Bar UI design template",
"backgroundImageUrl": "https://media-dev.appcharge.com/media/6555b69c02ee8eca00465694/background-image.png",
"title": {
"text": "Mission impossible!",
"fontColor": "#FFD700",
"fontSize": 10,
"fontWeight": "bold"
},
"subtitle": {
"text": "To infinity and beyond!",
"fontColor": "#FFD700",
"fontSize": 8,
"fontWeight": "normal"
},
"progressBar": {
"barFillColor": {
"colorOne": "#FFD450",
"colorTwo": "#EDB923",
"gradientDirection": "to bottom"
},
"barRadius": 12,
"accumulatedItem": {
"imageUrl": "https://media-dev.appcharge.com/media/6555b69c02ee8eca00465694/item.jpeg",
"ribbonImageUrl": "https://plus.unsplash.com/premium_photo-1681400545953-0ba00cfa7926?q=80&w=880&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D"
},
"backgroundOpacity": 80,
"frameRadius": 12
},
"borderColor": {
"colorOne": "#DBBD9C",
"colorTwo": "#DBBD9C",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#DABA98",
"colorTwo": "#FDFCF9",
"gradientDirection": "to right"
},
"borderWidth": 3,
"externalId": "progress-bar-design-single"
},
"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"
}
],
"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"
}
],
"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-single-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"
}
{
"offerId": "67890abcdef1234567890200",
"active": true,
"description": "A progress bar with all milestones visible at once.",
"displayName": "My Milestone Progress Bar",
"name": "My Milestone Progress Bar",
"type": "ProgressBar",
"offerUi": {
"id": "67890abcdef1234567890201",
"offerUiType": "ProgressBar",
"name": "Milestone Progress Bar Design",
"description": "Milestone Progress Bar UI design template",
"backgroundImageUrl": "https://media-dev.appcharge.com/media/6555b69c02ee8eca00465694/background-image.png",
"title": {
"text": "Reach Every Milestone",
"fontColor": "#FFD700",
"fontSize": 10,
"fontWeight": "bold"
},
"subtitle": {
"text": "Collect rewards along the way",
"fontColor": "#FFD700",
"fontSize": 8,
"fontWeight": "normal"
},
"progressBar": {
"barFillColor": {
"colorOne": "#FFD450",
"colorTwo": "#EDB923",
"gradientDirection": "to bottom"
},
"barRadius": 12,
"accumulatedItem": {
"imageUrl": "https://media-dev.appcharge.com/media/6555b69c02ee8eca00465694/item.jpeg",
"ribbonImageUrl": "https://plus.unsplash.com/premium_photo-1681400545953-0ba00cfa7926?q=80&w=880&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D"
},
"headerImageUrl": "https://plus.unsplash.com/premium_photo-1785080652560-f334e6ea704c?q=80&w=687&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
"backgroundColor": {
"colorOne": "#dde9f4",
"colorTwo": "#f66578",
"gradientDirection": "to bottom"
},
"textColor": "#FFD700",
"backgroundOpacity": 80,
"frameRadius": 12,
"type": "milestones",
"milestones": {
"milestoneCompletedIconUrl": "https://plus.unsplash.com/premium_photo-1681400545953-0ba00cfa7926?q=80&w=880&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
"tooltipBackgroundColor": "#1f9eec"
}
},
"borderColor": {
"colorOne": "#DBBD9C",
"colorTwo": "#DBBD9C",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#DABA98",
"colorTwo": "#FDFCF9",
"gradientDirection": "to right"
},
"borderWidth": 3,
"externalId": "progress-bar-design-milestones"
},
"productsSequence": [
{
"index": 1,
"products": [
{
"publisherProductId": "coins",
"quantity": 300,
"priority": "Main",
"quantityDisplay": "+ 300"
},
{
"publisherProductId": "gems",
"quantity": 50,
"priority": "Sub",
"quantityDisplay": "+ 50"
}
],
"priceInUsdCents": 0,
"barSize": 10,
"id": "67890abcdef1234567890202"
},
{
"index": 2,
"products": [
{
"publisherProductId": "coins",
"quantity": 500,
"priority": "Main",
"quantityDisplay": "+ 500"
},
{
"publisherProductId": "gems",
"quantity": 100,
"priority": "Sub",
"quantityDisplay": "+ 100"
}
],
"priceInUsdCents": 0,
"barSize": 20,
"id": "67890abcdef1234567890203"
},
{
"index": 3,
"products": [
{
"publisherProductId": "coins",
"quantity": 1000,
"priority": "Main",
"quantityDisplay": "+ 1000"
},
{
"publisherProductId": "gems",
"quantity": 250,
"priority": "Sub",
"quantityDisplay": "+ 250"
},
{
"publisherProductId": "energy",
"quantity": 100,
"priority": "Sub",
"quantityDisplay": "+ 100"
}
],
"priceInUsdCents": 0,
"barSize": 30,
"id": "67890abcdef1234567890204"
}
],
"publisherId": "6555b69c02ee8eca00465694",
"publisherOfferId": "progressBar-milestones-1",
"schedule": {
"permanent": false,
"timeFrames": [
{
"startTime": "2025-11-01T12:05:00.000Z",
"endTime": "2025-11-22T12:10:00.000Z",
"notes": "Holiday promotion period.",
"id": "67890abcdef1234567890205"
}
]
},
"segments": [
"New User",
"VIP Player"
],
"createdAt": "2024-11-15T09:30:00.000Z",
"updatedAt": "2024-11-15T09:30:00.000Z"
}
Headers
The publisher token used for authentication.
Body
application/json
The Progress Bar offer ID provided by the publisher. This is the offer's External ID value in the Publisher Dashboard.
Example:
"progressBar-1"
The name of the Progress Bar offer (at least 3 characters).
Example:
"My ProgressBar Offer 1"
The type of offer - In this case 'ProgressBar'.
Available options:
ProgressBar Example:
"ProgressBar"
Whether the Progress Bar offer is active.
Example:
true
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"]
The sequence of products included in the Progress Bar offer.
Show child attributes
Show child attributes
Internal ID of the offer design. Required if offerExternalUiId is not provided.
Example:
"67890abcdef1234567890124"
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"
The display name of the Progress Bar offer shown to players.
Example:
"My ProgresBar Offer"
Progress Bar offer description.
Example:
"This is my progress bar offer description."
The schedule for when the Progress Bar offer is available.
Show child attributes
Show child attributes
The publisher section ID.
Tab ID in the web store.
Response
Progress Bar offer created successfully.
Publisher ID.
Autogenerated Progress Bar offer ID.
Progress Bar offer ID provided by the publisher. This is the offer's External ID value in the Publisher Dashboard.
Progress Bar offer name.
The display name of the Progress Bar offer. If not provided, the name will be used.
Progress Bar offer description.
Offer type.
Example:
"ProgressBar"
Whether the Progress Bar offer is active.
The player segments associated with the Progress Bar offer.
Information about the Progress Bar offer design, as configured in the Publisher Dashboard.
Show child attributes
Show child attributes
The sequence of missions within the Progress Bar offer
Show child attributes
Show child attributes
The schedule for when the Progress Bar offer is available.
Show child attributes
Show child attributes
Date the Progress Bar offer was created.
Date the Progress Bar offer was last updated.
Was this page helpful?