v1

latestOpenAPI 3.1.02026-07-2665153355.3 KB

Offer Designs

Get Offer Designs

Retrieves a list of all offer designs.

get/components/v1/offer-design

Headers

x-publisher-tokenstring required

Publisher token, as displayed in the Publisher Dashboard.

Response

Offer designs retrieved successfully.

idstring

Offer design ID.

offerUiType'SpecialOffer' | 'Bundle' | 'PopUp' | 'RollingOffer'

Type of offer design.

offerUiSubType'DailyBonus' | 'PostPurchase' | 'RewardCalendar'

Popup design subtype. Only relevant when offerUiType is PopUp.

namestring

Offer design name.

externalIdstring

Offer design ID that you defined.

backgroundImageUrlstring url

Background image URL for the offer design.

externalBackgroundImageUrlstring url

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

backgroundExternalImageUrlstring url

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

buttonSuffixImagestring

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

buttonSuffixAnimationstring

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

backgroundOpacitynumber

Background opacity value. Only relevant for Rolling Offers.

headerImagestring url

Header image URL. Only relevant for Rolling Offers.

arrowColorstring

Arrow color. Only relevant for Rolling Offers.

borderWidthnumber

Border width in pixels. Only relevant for Rolling Offers.

Example response

[
  {
    "id": "68b3e3473e2ea6249862bddf",
    "offerUiType": "Bundle",
    "offerUiSubType": "DailyBonus",
    "name": "Starter Bundle Design",
    "externalId": "starter-bundle-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "externalBackgroundImageUrl": "https://cdn.example.com/assets/background.png",
    "backgroundExternalImageUrl": "https://cdn.example.com/assets/background.png",
    "title": {
      "text": "Limited Time Offer",
      "fontColor": {
        "colorOne": "#FFFFFF",
        "colorTwo": "#FDFCF9",
        "direction": "to right"
      },
      "fontSize": 20,
      "fontWeight": "bold"
    },
    "buttonSuffixImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/bundle-button-suffix.png",
    "buttonSuffixAnimation": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/bundle-button-suffix-animation.json",
    "backgroundColor": {
      "colorOne": "#E7CF88",
      "colorTwo": "#FDFCF9",
      "gradientDirection": "to right"
    },
    "backgroundOpacity": 80,
    "headerImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/header.png",
    "arrowColor": "#ffffff",
    "borderColor": {
      "colorOne": "#FFFFFF",
      "colorTwo": "#FDFCF9",
      "direction": "to right"
    },
    "borderWidth": 2,
    "subRollingOffer": {
      "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/sub-background.png",
      "backgroundExternalImageUrl": "https://cdn.example.com/assets/background.png",
      "collectText": "FREE"
    },
    "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"
    }
  }
]