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": "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": "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"
}
}
Create Post Purchase Popup Design
Creates a post purchase 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": "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": "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"
}
}
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": "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": "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"
}
}
Headers
Publisher token, as displayed in the Publisher Dashboard.
Body
Creates a post purchase popup design.
Type of offer design.
PopUp "PopUp"
Offer design name.
"Post Purchase Popup Design"
Design ID that you define.
"post-purchase-popup-design"
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.
"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png"
Popup design subtype. Use PostPurchase for post purchase popup designs.
PostPurchase "PostPurchase"
Show child attributes
Show child attributes
Response
Offer design created successfully.
Design ID.
"6a09aa1018b751228b09faed"
Type of offer design.
PopUp "PopUp"
Offer design name.
"Post Purchase Popup Design"
Design ID that you defined.
"post-purchase-popup-design"
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.
"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png"
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.
"https://cdn.example.com/assets/background.png"
Popup design subtype. Use PostPurchase for post purchase popup designs.
PostPurchase "PostPurchase"
Was this page helpful?