Create Store Refresh Popup Design

Creates a store refresh popup design.

POST /components/v1/offer-design

Create Store Refresh Popup 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": "StoreRefresh",
    "name": "Store Refresh Popup Design",
    "externalId": "store-refresh-popup-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "title": {
      "text": "Welcome back",
      "fontColor": "#FFFFFF",
      "fontSize": 20,
      "fontWeight": "normal"
    }
  }'

Create Store Refresh Popup Design

{
  "id": "68cbf09967ba5ab776c2745e",
  "offerUiType": "PopUp",
  "offerUiSubType": "StoreRefresh",
  "name": "Store Refresh Popup Design",
  "externalId": "store-refresh-popup-design",
  "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
  "title": {
    "text": "Welcome back",
    "fontColor": "#FFFFFF",
    "fontSize": 20,
    "fontWeight": "normal"
  }
}

Create Store Refresh Popup 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": "StoreRefresh",
    "name": "Store Refresh Popup Design",
    "externalId": "store-refresh-popup-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "title": {
      "text": "Welcome back",
      "fontColor": "#FFFFFF",
      "fontSize": 20,
      "fontWeight": "normal"
    }
  }'

Create Store Refresh Popup Design

{
  "id": "68cbf09967ba5ab776c2745e",
  "offerUiType": "PopUp",
  "offerUiSubType": "StoreRefresh",
  "name": "Store Refresh Popup Design",
  "externalId": "store-refresh-popup-design",
  "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
  "title": {
    "text": "Welcome back",
    "fontColor": "#FFFFFF",
    "fontSize": 20,
    "fontWeight": "normal"
  }
}

Authorizations

x-publisher-token · string · header · required

Publisher token, as displayed in the Publisher Dashboard.

Body

application/json

Creates a store refresh popup design.

offerUiType · enum<string> · required

Type of offer design.

Available options: PopUp

name · string · required

Offer design name.

externalId · string · required

Design ID that you define.

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.

title · object

Show child attributes

offerUiSubType · enum<string>

Popup design subtype. Use StoreRefresh for store refresh popup designs.

Available options: StoreRefresh

Response

200

application/json

Offer design created successfully.

id · string

Design ID.

offerUiType · enum<string>

Type of offer design.

Available options: PopUp

name · string

Offer design name.

externalId · string

Design ID that you defined.

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.

title · object

Show child attributes

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.

offerUiSubType · enum<string>

Popup design subtype. Use StoreRefresh for store refresh popup designs.

Available options: StoreRefresh