Create Reward Calendar Design

Creates a reward calendar design.

POST /components/v1/offer-design

Create Reward Calendar Design

curl -X POST \
  'https://api.appcharge.com/components/v1/offer-design' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  --data '{
    "offerUiType": "PopUp",
    "offerUiSubType": "RewardCalendar",
    "name": "Weekly Reward Calendar 1",
    "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"
    }
  }'

Create Reward Calendar Design

{
  "id": "68d2b9cf7a8b4d2f1b8e0a31",
  "offerUiType": "PopUp",
  "offerUiSubType": "RewardCalendar",
  "name": "Weekly Reward Calendar 1",
  "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"
  }
}

Create Reward Calendar Design

curl -X POST \
  'https://api.appcharge.com/components/v1/offer-design' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  --data '{
    "offerUiType": "PopUp",
    "offerUiSubType": "RewardCalendar",
    "name": "Weekly Reward Calendar 1",
    "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"
    }
  }'

Create Reward Calendar Design

{
  "id": "68d2b9cf7a8b4d2f1b8e0a31",
  "offerUiType": "PopUp",
  "offerUiSubType": "RewardCalendar",
  "name": "Weekly Reward Calendar 1",
  "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"
  }
}

Authorizations

x-publisher-token · string · header · required

Publisher token, as displayed in the Publisher Dashboard.

Body

application/json

Creates a reward calendar design.

offerUiType · enum<string> · required

Type of offer design.

Available options: PopUp

Example:

"PopUp"

offerUiSubType · enum<string> · required

Offer subtype.

Available options: RewardCalendar

Example:

"RewardCalendar"

name · string · required

Offer design name.

Example:

"Weekly Reward Calendar"

externalId · string · required

Offer design ID that you define.

Example:

"reward-calendar-ui"

backgroundImageUrl · string<url> · required

Background image URL in PNG or JPEG format.

For uploaded files, this is the Appcharge-hosted CDN URL. For external image URLs, this is the original image URL served from the provided URL. External image URLs are saved and used as-is, and Appcharge doesn't download, copy, upload, or host them. Images must remain available at the provided URLs.

We recommend uploading image files instead of using external URLs when possible.

Example:

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

rewardCalendar · object · required

Information about the reward calendar design.

Show child attributes

Response

200

application/json

Offer design created successfully.

id · string

Offer design ID.

Example:

"68d2b9cf7a8b4d2f1b8e0a31"

offerUiType · enum<string>

Type of offer design.

Available options: PopUp

Example:

"PopUp"

offerUiSubType · enum<string>

Offer subtype.

Available options: RewardCalendar

Example:

"RewardCalendar"

name · string

Offer design name.

Example:

"Weekly Reward Calendar"

externalId · string

Offer design ID that you defined.

Example:

"reward-calendar-ui"

backgroundImageUrl · string<url>

Background image URL. For uploaded files, this is the Appcharge-hosted CDN URL. For external image URLs, this is the original image URL served from the provided URL.

Example:

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

externalBackgroundImageUrl · string<url>

Original background image URL when the design uses an external image URL. This URL is used as provided to serve the image.

Example:

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

rewardCalendar · object

Information about the reward calendar design.

Show child attributes