Sign in

v1

latestOpenAPI 3.1.02026-07-2665153355.3 KB
Offer Designs

Deletes a post purchase popup design.

delete/components/v1/offer-design/{externalId}

Response

Post purchase popup design deleted successfully.

idstring

Design ID.

offerUiType'PopUp'

Type of offer design.

namestring

Offer design name.

externalIdstring

Design ID that you defined.

backgroundImageUrlstring 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.

externalBackgroundImageUrlstring url

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

offerUiSubType'PostPurchase'

Popup design subtype. Use PostPurchase for post purchase popup designs.

Example response

{
  "id": "6a09aa1018b751228b09faed",
  "offerUiType": "PopUp",
  "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"
  },
  "externalBackgroundImageUrl": "https://cdn.example.com/assets/background.png",
  "offerUiSubType": "PostPurchase"
}