Skip to main content
GET
/
components
/
v1
/
offer-design
curl -X GET \
  'https://api.appcharge.com/components/v1/offer-design' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'x-publisher-token: <x-publisher-token>'

[
  {
    "id": "68b3e3473e2ea6249862bddf",
    "offerUiType": "Bundle",
    "name": "Starter Bundle Design",
    "externalId": "starter-bundle-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "backgroundColor": {
      "colorOne": "#E7CF88",
      "colorTwo": "#FDFCF9",
      "gradientDirection": "to right"
    },
    "buttonSuffixImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/bundle-button-suffix.png",
    "buttonSuffixAnimation": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/bundle-button-suffix-animation.json"
  },
  {
    "id": "68b3f37f3a2852af1a154fae",
    "offerUiType": "SpecialOffer",
    "name": "Summer Special Design",
    "externalId": "summer-special-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "title": {
      "text": "Limited Time Offer",
      "fontColor": {
        "colorOne": "#ffffff"
      },
      "fontSize": 20,
      "fontWeight": "bold"
    },
    "buttonSuffixImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/special-offer-button-suffix.png",
    "buttonSuffixAnimation": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/special-offer-button-suffix-animation.json"
  },
  {
    "id": "68cbf09967ba5ab776c2745e",
    "offerUiType": "PopUp",
    "offerUiSubType": "DailyBonus",
    "name": "Daily Bonus Design",
    "externalId": "daily-bonus-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "title": {
      "text": "Your daily bonus!",
      "fontColor": "#FFFFFF",
      "fontSize": 20,
      "fontWeight": "normal"
    }
  },
  {
    "id": "68d2b9cf7a8b4d2f1b8e0a31",
    "offerUiType": "PopUp",
    "offerUiSubType": "RewardCalendar",
    "name": "Weekly Reward Calendar",
    "externalId": "reward-calendar-design-1",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/reward-calendar-background.png",
    "rewardCalendar": {
      "collectibleBadgeImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/collectible-badge.png",
      "lockedBadgeImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/locked-badge.png",
      "backgroundColor": "#101225",
      "collectIconImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/collect-icon.png",
      "lockedIconImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/locked-icon.png",
      "dayFontColor": "#FFFFFF",
      "subRewardBackgroundImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/sub-reward-background.png",
      "mainRewardBackgroundImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/main-reward-background.png",
      "headerImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/header.png"
    }
  },
  {
    "id": "6a09aa1018b751228b09faed",
    "offerUiType": "PopUp",
    "offerUiSubType": "PostPurchase",
    "name": "Post Purchase Popup Design",
    "externalId": "post-purchase-popup-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "title": {
      "text": "Post purchase offer",
      "fontColor": "#FFFFFF",
      "fontSize": 20,
      "fontWeight": "medium"
    }
  },
  {
    "id": "694a7c8e87f78fb36a931763",
    "offerUiType": "RollingOffer",
    "name": "Rolling Offer Design",
    "externalId": "rolling-offer-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "backgroundColor": "#272727",
    "backgroundOpacity": 80,
    "headerImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/header.png",
    "arrowColor": "#ffffff",
    "borderColor": {
      "colorOne": "#ffffff",
      "colorTwo": "#ffffff",
      "direction": "to right"
    },
    "borderWidth": 2,
    "subRollingOffer": {
      "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/sub-background.png",
      "collectText": "FREE"
    }
  }
]

curl -X GET \
  'https://api.appcharge.com/components/v1/offer-design' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'x-publisher-token: <x-publisher-token>'

[
  {
    "id": "68b3e3473e2ea6249862bddf",
    "offerUiType": "Bundle",
    "name": "Starter Bundle Design",
    "externalId": "starter-bundle-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "backgroundColor": {
      "colorOne": "#E7CF88",
      "colorTwo": "#FDFCF9",
      "gradientDirection": "to right"
    },
    "buttonSuffixImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/bundle-button-suffix.png",
    "buttonSuffixAnimation": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/bundle-button-suffix-animation.json"
  },
  {
    "id": "68b3f37f3a2852af1a154fae",
    "offerUiType": "SpecialOffer",
    "name": "Summer Special Design",
    "externalId": "summer-special-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "title": {
      "text": "Limited Time Offer",
      "fontColor": {
        "colorOne": "#ffffff"
      },
      "fontSize": 20,
      "fontWeight": "bold"
    },
    "buttonSuffixImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/special-offer-button-suffix.png",
    "buttonSuffixAnimation": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/special-offer-button-suffix-animation.json"
  },
  {
    "id": "68cbf09967ba5ab776c2745e",
    "offerUiType": "PopUp",
    "offerUiSubType": "DailyBonus",
    "name": "Daily Bonus Design",
    "externalId": "daily-bonus-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "title": {
      "text": "Your daily bonus!",
      "fontColor": "#FFFFFF",
      "fontSize": 20,
      "fontWeight": "normal"
    }
  },
  {
    "id": "68d2b9cf7a8b4d2f1b8e0a31",
    "offerUiType": "PopUp",
    "offerUiSubType": "RewardCalendar",
    "name": "Weekly Reward Calendar",
    "externalId": "reward-calendar-design-1",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/reward-calendar-background.png",
    "rewardCalendar": {
      "collectibleBadgeImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/collectible-badge.png",
      "lockedBadgeImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/locked-badge.png",
      "backgroundColor": "#101225",
      "collectIconImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/collect-icon.png",
      "lockedIconImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/locked-icon.png",
      "dayFontColor": "#FFFFFF",
      "subRewardBackgroundImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/sub-reward-background.png",
      "mainRewardBackgroundImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/main-reward-background.png",
      "headerImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/header.png"
    }
  },
  {
    "id": "6a09aa1018b751228b09faed",
    "offerUiType": "PopUp",
    "offerUiSubType": "PostPurchase",
    "name": "Post Purchase Popup Design",
    "externalId": "post-purchase-popup-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "title": {
      "text": "Post purchase offer",
      "fontColor": "#FFFFFF",
      "fontSize": 20,
      "fontWeight": "medium"
    }
  },
  {
    "id": "694a7c8e87f78fb36a931763",
    "offerUiType": "RollingOffer",
    "name": "Rolling Offer Design",
    "externalId": "rolling-offer-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "backgroundColor": "#272727",
    "backgroundOpacity": 80,
    "headerImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/header.png",
    "arrowColor": "#ffffff",
    "borderColor": {
      "colorOne": "#ffffff",
      "colorTwo": "#ffffff",
      "direction": "to right"
    },
    "borderWidth": 2,
    "subRollingOffer": {
      "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/sub-background.png",
      "collectText": "FREE"
    }
  }
]

Authorizations

​
x-publisher-token
string
header
required

Publisher token, as displayed in the Publisher Dashboard.

Headers

​
x-publisher-token
string
required

Publisher token, as displayed in the Publisher Dashboard.

Response

200 - application/json

Offer designs retrieved successfully.

​
id
string

Offer design ID.

Example:

"68b3e3473e2ea6249862bddf"

​
offerUiType
enum<string>

Type of offer design.

Available options:
SpecialOffer,
Bundle,
PopUp,
RollingOffer
Example:

"Bundle"

​
offerUiSubType
enum<string>

Popup design subtype. Only relevant when offerUiType is PopUp.

Available options:
DailyBonus,
PostPurchase,
RewardCalendar
Example:

"DailyBonus"

​
name
string

Offer design name.

Example:

"Starter Bundle Design"

​
externalId
string

Offer design ID that you defined.

Example:

"starter-bundle-design"

​
backgroundImageUrl
string<url>

Background image URL for the offer design.

Example:

"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png"

​
externalBackgroundImageUrl
string<url>

Original background image URL when the design uses an external image URL.

Example:

"https://cdn.example.com/assets/background.png"

​
backgroundExternalImageUrl
string<url>

Original background image URL when an external image URL is used. Only relevant for Rolling Offers.

Example:

"https://cdn.example.com/assets/background.png"

​
title
object

Title configuration. Only relevant for Special Offers, Daily Bonuses, and Triggered Popups.

​
buttonSuffixImage
string

Button asset suffix. Only relevant for Bundles and Special Offers.

Example:

"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/bundle-button-suffix.png"

​
buttonSuffixAnimation
string

Button asset suffix animation. Only relevant for Bundles and Special Offers.

Example:

"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/bundle-button-suffix-animation.json"

​
backgroundColor
object

Background color.

Note: For Rolling Offers, this property is returned as a string. For Bundles, this property is returned as an object as shown below.

​
backgroundOpacity
number

Background opacity value. Only relevant for Rolling Offers.

Example:

80

​
headerImage
string<url>

Header image URL. Only relevant for Rolling Offers.

Example:

"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/header.png"

​
arrowColor
string

Arrow color. Only relevant for Rolling Offers.

Example:

"#ffffff"

​
borderColor
object

Border color configuration. Only relevant for Rolling Offers.

​
borderWidth
number

Border width in pixels. Only relevant for Rolling Offers.

Example:

2

​
subRollingOffer
object

Sub rolling offer configuration. Only relevant for Rolling Offers.

​
rewardCalendar
object

Reward calendar design configuration. Only relevant for Reward Calendars.