curl -X PUT \
'https://api.appcharge.com/components/v1/offer-design/progress-bar-design-classic' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
--data '{
"offerUiType": "ProgressBar",
"name": "Classic Progress Bar Design Updated",
"externalId": "progress-bar-design-classic",
"backgroundImageUrl": "https://media.appcharge.com/defaults/background.png",
"backgroundColor": {
"colorOne": "#222222",
"colorTwo": "#444444",
"gradientDirection": "to bottom"
},
"backgroundOpacity": 90,
"frameRadius": 12,
"headerImageUrl": "https://example.com/header-new.png",
"title": {
"text": "Updated Classic Bar",
"fontColor": "#FF0000",
"fontSize": 12,
"fontWeight": "bold"
},
"subtitle": {
"text": "New rewards at every step",
"fontColor": "#FF0000",
"fontSize": 9,
"fontWeight": "medium"
},
"progressBar": {
"barFillColor": {
"colorOne": "#00FF00",
"colorTwo": "#007700",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#333333",
"colorTwo": "#555555",
"gradientDirection": "to right"
},
"borderColor": {
"colorOne": "#FF0000",
"colorTwo": "#880000",
"gradientDirection": "to bottom"
},
"borderWidth": 4,
"barRadius": 8,
"accumulatedItem": {
"imageUrl": "https://example.com/item-new.png",
"ribbonImageUrl": "https://example.com/ribbon-new.png"
},
"textColor": "#FF0000",
"type": "classic"
}
}'
curl -X PUT \
'https://api.appcharge.com/components/v1/offer-design/progress-bar-design-milestones' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
--data '{
"offerUiType": "ProgressBar",
"name": "Milestone Progress Bar Design Updated",
"externalId": "progress-bar-design-milestones",
"backgroundImageUrl": "https://media.appcharge.com/defaults/background.png",
"backgroundColor": {
"colorOne": "#222222",
"colorTwo": "#444444",
"gradientDirection": "to bottom"
},
"backgroundOpacity": 90,
"frameRadius": 12,
"headerImageUrl": "https://example.com/header-new.png",
"title": {
"text": "Updated Milestone Bar",
"fontColor": "#FF0000",
"fontSize": 12,
"fontWeight": "bold"
},
"subtitle": {
"text": "New rewards at every step",
"fontColor": "#FF0000",
"fontSize": 9,
"fontWeight": "medium"
},
"progressBar": {
"barFillColor": {
"colorOne": "#00FF00",
"colorTwo": "#007700",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#333333",
"colorTwo": "#555555",
"gradientDirection": "to right"
},
"borderColor": {
"colorOne": "#FF0000",
"colorTwo": "#880000",
"gradientDirection": "to bottom"
},
"borderWidth": 4,
"barRadius": 8,
"accumulatedItem": {
"imageUrl": "https://example.com/item-new.png",
"ribbonImageUrl": "https://example.com/ribbon-new.png"
},
"textColor": "#FF0000",
"type": "milestones",
"milestones": {
"milestoneCompletedIconUrl": "https://example.com/checkmark-new.png",
"tooltipBackgroundColor": "#1f9eec"
}
}
}'
{
"id": "6a2536c0b0fbdcd303bd861b",
"offerUiType": "ProgressBar",
"name": "Classic Progress Bar Design Updated",
"externalId": "progress-bar-design-classic",
"backgroundImageUrl": "https://media.appcharge.com/defaults/background.png",
"backgroundColor": {
"colorOne": "#222222",
"colorTwo": "#444444",
"gradientDirection": "to bottom"
},
"backgroundOpacity": 90,
"frameRadius": 12,
"headerImageUrl": "https://example.com/header-new.png",
"title": {
"text": "Updated Classic Bar",
"fontColor": "#FF0000",
"fontSize": 12,
"fontWeight": "bold"
},
"subtitle": {
"text": "New rewards at every step",
"fontColor": "#FF0000",
"fontSize": 9,
"fontWeight": "medium"
},
"progressBar": {
"barFillColor": {
"colorOne": "#00FF00",
"colorTwo": "#007700",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#333333",
"colorTwo": "#555555",
"gradientDirection": "to right"
},
"borderColor": {
"colorOne": "#FF0000",
"colorTwo": "#880000",
"gradientDirection": "to bottom"
},
"borderWidth": 4,
"barRadius": 8,
"accumulatedItem": {
"imageUrl": "https://example.com/item-new.png",
"ribbonImageUrl": "https://example.com/ribbon-new.png"
},
"textColor": "#FF0000",
"type": "classic",
"milestones": null
}
}
{
"id": "6a2536c0b0fbdcd303bd861c",
"offerUiType": "ProgressBar",
"name": "Milestone Progress Bar Design Updated",
"externalId": "progress-bar-design-milestones",
"backgroundImageUrl": "https://media.appcharge.com/defaults/background.png",
"backgroundColor": {
"colorOne": "#222222",
"colorTwo": "#444444",
"gradientDirection": "to bottom"
},
"backgroundOpacity": 90,
"frameRadius": 12,
"headerImageUrl": "https://example.com/header-new.png",
"title": {
"text": "Updated Milestone Bar",
"fontColor": "#FF0000",
"fontSize": 12,
"fontWeight": "bold"
},
"subtitle": {
"text": "New rewards at every step",
"fontColor": "#FF0000",
"fontSize": 9,
"fontWeight": "medium"
},
"progressBar": {
"barFillColor": {
"colorOne": "#00FF00",
"colorTwo": "#007700",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#333333",
"colorTwo": "#555555",
"gradientDirection": "to right"
},
"borderColor": {
"colorOne": "#FF0000",
"colorTwo": "#880000",
"gradientDirection": "to bottom"
},
"borderWidth": 4,
"barRadius": 8,
"accumulatedItem": {
"imageUrl": "https://example.com/item-new.png",
"ribbonImageUrl": "https://example.com/ribbon-new.png"
},
"textColor": "#FF0000",
"type": "milestones",
"milestones": {
"milestoneCompletedIconUrl": "https://example.com/checkmark-new.png",
"tooltipBackgroundColor": "#1f9eec"
}
}
}
Progress Bars
Update Progress Bar Design
Updates a progress bar design.
When you update a progress bar design, progressBar.type defaults to classic. To keep a milestones design, set progressBar.type to milestones and include the milestones object.
PUT
/
components
/
v1
/
offer-design
/
{externalId}
curl -X PUT \
'https://api.appcharge.com/components/v1/offer-design/progress-bar-design-classic' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
--data '{
"offerUiType": "ProgressBar",
"name": "Classic Progress Bar Design Updated",
"externalId": "progress-bar-design-classic",
"backgroundImageUrl": "https://media.appcharge.com/defaults/background.png",
"backgroundColor": {
"colorOne": "#222222",
"colorTwo": "#444444",
"gradientDirection": "to bottom"
},
"backgroundOpacity": 90,
"frameRadius": 12,
"headerImageUrl": "https://example.com/header-new.png",
"title": {
"text": "Updated Classic Bar",
"fontColor": "#FF0000",
"fontSize": 12,
"fontWeight": "bold"
},
"subtitle": {
"text": "New rewards at every step",
"fontColor": "#FF0000",
"fontSize": 9,
"fontWeight": "medium"
},
"progressBar": {
"barFillColor": {
"colorOne": "#00FF00",
"colorTwo": "#007700",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#333333",
"colorTwo": "#555555",
"gradientDirection": "to right"
},
"borderColor": {
"colorOne": "#FF0000",
"colorTwo": "#880000",
"gradientDirection": "to bottom"
},
"borderWidth": 4,
"barRadius": 8,
"accumulatedItem": {
"imageUrl": "https://example.com/item-new.png",
"ribbonImageUrl": "https://example.com/ribbon-new.png"
},
"textColor": "#FF0000",
"type": "classic"
}
}'
curl -X PUT \
'https://api.appcharge.com/components/v1/offer-design/progress-bar-design-milestones' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
--data '{
"offerUiType": "ProgressBar",
"name": "Milestone Progress Bar Design Updated",
"externalId": "progress-bar-design-milestones",
"backgroundImageUrl": "https://media.appcharge.com/defaults/background.png",
"backgroundColor": {
"colorOne": "#222222",
"colorTwo": "#444444",
"gradientDirection": "to bottom"
},
"backgroundOpacity": 90,
"frameRadius": 12,
"headerImageUrl": "https://example.com/header-new.png",
"title": {
"text": "Updated Milestone Bar",
"fontColor": "#FF0000",
"fontSize": 12,
"fontWeight": "bold"
},
"subtitle": {
"text": "New rewards at every step",
"fontColor": "#FF0000",
"fontSize": 9,
"fontWeight": "medium"
},
"progressBar": {
"barFillColor": {
"colorOne": "#00FF00",
"colorTwo": "#007700",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#333333",
"colorTwo": "#555555",
"gradientDirection": "to right"
},
"borderColor": {
"colorOne": "#FF0000",
"colorTwo": "#880000",
"gradientDirection": "to bottom"
},
"borderWidth": 4,
"barRadius": 8,
"accumulatedItem": {
"imageUrl": "https://example.com/item-new.png",
"ribbonImageUrl": "https://example.com/ribbon-new.png"
},
"textColor": "#FF0000",
"type": "milestones",
"milestones": {
"milestoneCompletedIconUrl": "https://example.com/checkmark-new.png",
"tooltipBackgroundColor": "#1f9eec"
}
}
}'
{
"id": "6a2536c0b0fbdcd303bd861b",
"offerUiType": "ProgressBar",
"name": "Classic Progress Bar Design Updated",
"externalId": "progress-bar-design-classic",
"backgroundImageUrl": "https://media.appcharge.com/defaults/background.png",
"backgroundColor": {
"colorOne": "#222222",
"colorTwo": "#444444",
"gradientDirection": "to bottom"
},
"backgroundOpacity": 90,
"frameRadius": 12,
"headerImageUrl": "https://example.com/header-new.png",
"title": {
"text": "Updated Classic Bar",
"fontColor": "#FF0000",
"fontSize": 12,
"fontWeight": "bold"
},
"subtitle": {
"text": "New rewards at every step",
"fontColor": "#FF0000",
"fontSize": 9,
"fontWeight": "medium"
},
"progressBar": {
"barFillColor": {
"colorOne": "#00FF00",
"colorTwo": "#007700",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#333333",
"colorTwo": "#555555",
"gradientDirection": "to right"
},
"borderColor": {
"colorOne": "#FF0000",
"colorTwo": "#880000",
"gradientDirection": "to bottom"
},
"borderWidth": 4,
"barRadius": 8,
"accumulatedItem": {
"imageUrl": "https://example.com/item-new.png",
"ribbonImageUrl": "https://example.com/ribbon-new.png"
},
"textColor": "#FF0000",
"type": "classic",
"milestones": null
}
}
{
"id": "6a2536c0b0fbdcd303bd861c",
"offerUiType": "ProgressBar",
"name": "Milestone Progress Bar Design Updated",
"externalId": "progress-bar-design-milestones",
"backgroundImageUrl": "https://media.appcharge.com/defaults/background.png",
"backgroundColor": {
"colorOne": "#222222",
"colorTwo": "#444444",
"gradientDirection": "to bottom"
},
"backgroundOpacity": 90,
"frameRadius": 12,
"headerImageUrl": "https://example.com/header-new.png",
"title": {
"text": "Updated Milestone Bar",
"fontColor": "#FF0000",
"fontSize": 12,
"fontWeight": "bold"
},
"subtitle": {
"text": "New rewards at every step",
"fontColor": "#FF0000",
"fontSize": 9,
"fontWeight": "medium"
},
"progressBar": {
"barFillColor": {
"colorOne": "#00FF00",
"colorTwo": "#007700",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#333333",
"colorTwo": "#555555",
"gradientDirection": "to right"
},
"borderColor": {
"colorOne": "#FF0000",
"colorTwo": "#880000",
"gradientDirection": "to bottom"
},
"borderWidth": 4,
"barRadius": 8,
"accumulatedItem": {
"imageUrl": "https://example.com/item-new.png",
"ribbonImageUrl": "https://example.com/ribbon-new.png"
},
"textColor": "#FF0000",
"type": "milestones",
"milestones": {
"milestoneCompletedIconUrl": "https://example.com/checkmark-new.png",
"tooltipBackgroundColor": "#1f9eec"
}
}
}
curl -X PUT \
'https://api.appcharge.com/components/v1/offer-design/progress-bar-design-classic' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
--data '{
"offerUiType": "ProgressBar",
"name": "Classic Progress Bar Design Updated",
"externalId": "progress-bar-design-classic",
"backgroundImageUrl": "https://media.appcharge.com/defaults/background.png",
"backgroundColor": {
"colorOne": "#222222",
"colorTwo": "#444444",
"gradientDirection": "to bottom"
},
"backgroundOpacity": 90,
"frameRadius": 12,
"headerImageUrl": "https://example.com/header-new.png",
"title": {
"text": "Updated Classic Bar",
"fontColor": "#FF0000",
"fontSize": 12,
"fontWeight": "bold"
},
"subtitle": {
"text": "New rewards at every step",
"fontColor": "#FF0000",
"fontSize": 9,
"fontWeight": "medium"
},
"progressBar": {
"barFillColor": {
"colorOne": "#00FF00",
"colorTwo": "#007700",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#333333",
"colorTwo": "#555555",
"gradientDirection": "to right"
},
"borderColor": {
"colorOne": "#FF0000",
"colorTwo": "#880000",
"gradientDirection": "to bottom"
},
"borderWidth": 4,
"barRadius": 8,
"accumulatedItem": {
"imageUrl": "https://example.com/item-new.png",
"ribbonImageUrl": "https://example.com/ribbon-new.png"
},
"textColor": "#FF0000",
"type": "classic"
}
}'
curl -X PUT \
'https://api.appcharge.com/components/v1/offer-design/progress-bar-design-milestones' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
--data '{
"offerUiType": "ProgressBar",
"name": "Milestone Progress Bar Design Updated",
"externalId": "progress-bar-design-milestones",
"backgroundImageUrl": "https://media.appcharge.com/defaults/background.png",
"backgroundColor": {
"colorOne": "#222222",
"colorTwo": "#444444",
"gradientDirection": "to bottom"
},
"backgroundOpacity": 90,
"frameRadius": 12,
"headerImageUrl": "https://example.com/header-new.png",
"title": {
"text": "Updated Milestone Bar",
"fontColor": "#FF0000",
"fontSize": 12,
"fontWeight": "bold"
},
"subtitle": {
"text": "New rewards at every step",
"fontColor": "#FF0000",
"fontSize": 9,
"fontWeight": "medium"
},
"progressBar": {
"barFillColor": {
"colorOne": "#00FF00",
"colorTwo": "#007700",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#333333",
"colorTwo": "#555555",
"gradientDirection": "to right"
},
"borderColor": {
"colorOne": "#FF0000",
"colorTwo": "#880000",
"gradientDirection": "to bottom"
},
"borderWidth": 4,
"barRadius": 8,
"accumulatedItem": {
"imageUrl": "https://example.com/item-new.png",
"ribbonImageUrl": "https://example.com/ribbon-new.png"
},
"textColor": "#FF0000",
"type": "milestones",
"milestones": {
"milestoneCompletedIconUrl": "https://example.com/checkmark-new.png",
"tooltipBackgroundColor": "#1f9eec"
}
}
}'
{
"id": "6a2536c0b0fbdcd303bd861b",
"offerUiType": "ProgressBar",
"name": "Classic Progress Bar Design Updated",
"externalId": "progress-bar-design-classic",
"backgroundImageUrl": "https://media.appcharge.com/defaults/background.png",
"backgroundColor": {
"colorOne": "#222222",
"colorTwo": "#444444",
"gradientDirection": "to bottom"
},
"backgroundOpacity": 90,
"frameRadius": 12,
"headerImageUrl": "https://example.com/header-new.png",
"title": {
"text": "Updated Classic Bar",
"fontColor": "#FF0000",
"fontSize": 12,
"fontWeight": "bold"
},
"subtitle": {
"text": "New rewards at every step",
"fontColor": "#FF0000",
"fontSize": 9,
"fontWeight": "medium"
},
"progressBar": {
"barFillColor": {
"colorOne": "#00FF00",
"colorTwo": "#007700",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#333333",
"colorTwo": "#555555",
"gradientDirection": "to right"
},
"borderColor": {
"colorOne": "#FF0000",
"colorTwo": "#880000",
"gradientDirection": "to bottom"
},
"borderWidth": 4,
"barRadius": 8,
"accumulatedItem": {
"imageUrl": "https://example.com/item-new.png",
"ribbonImageUrl": "https://example.com/ribbon-new.png"
},
"textColor": "#FF0000",
"type": "classic",
"milestones": null
}
}
{
"id": "6a2536c0b0fbdcd303bd861c",
"offerUiType": "ProgressBar",
"name": "Milestone Progress Bar Design Updated",
"externalId": "progress-bar-design-milestones",
"backgroundImageUrl": "https://media.appcharge.com/defaults/background.png",
"backgroundColor": {
"colorOne": "#222222",
"colorTwo": "#444444",
"gradientDirection": "to bottom"
},
"backgroundOpacity": 90,
"frameRadius": 12,
"headerImageUrl": "https://example.com/header-new.png",
"title": {
"text": "Updated Milestone Bar",
"fontColor": "#FF0000",
"fontSize": 12,
"fontWeight": "bold"
},
"subtitle": {
"text": "New rewards at every step",
"fontColor": "#FF0000",
"fontSize": 9,
"fontWeight": "medium"
},
"progressBar": {
"barFillColor": {
"colorOne": "#00FF00",
"colorTwo": "#007700",
"gradientDirection": "to right"
},
"backgroundColor": {
"colorOne": "#333333",
"colorTwo": "#555555",
"gradientDirection": "to right"
},
"borderColor": {
"colorOne": "#FF0000",
"colorTwo": "#880000",
"gradientDirection": "to bottom"
},
"borderWidth": 4,
"barRadius": 8,
"accumulatedItem": {
"imageUrl": "https://example.com/item-new.png",
"ribbonImageUrl": "https://example.com/ribbon-new.png"
},
"textColor": "#FF0000",
"type": "milestones",
"milestones": {
"milestoneCompletedIconUrl": "https://example.com/checkmark-new.png",
"tooltipBackgroundColor": "#1f9eec"
}
}
}
Body
application/json
Updates a progress bar design.
Response
Offer design updated successfully.
Was this page helpful?
