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"
}
}'
{
"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
Creates a 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"
}
}'
{
"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"
}
}
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"
}
}'
{
"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
Publisher token, as displayed in the Publisher Dashboard.
Body
Creates a store refresh popup design.
Type of offer design.
PopUp Offer design name.
Design ID that you define.
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.
Show child attributes
Show child attributes
Popup design subtype. Use StoreRefresh for store refresh popup designs.
StoreRefresh Response
Offer design created successfully.
Design ID.
Type of offer design.
PopUp Offer design name.
Design ID that you defined.
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.
Show child attributes
Show child attributes
Original background image URL when the design uses an external image URL. This URL is used as provided to serve the image.
Popup design subtype. Use StoreRefresh for store refresh popup designs.
StoreRefresh Was this page helpful?