curl -X DELETE \
'https://api.appcharge.com/components/v1/offer-design/summer-special-design' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-publisher-token: <x-publisher-token>'
{
"id": "68b3f37f3a2852af1a154fae",
"offerUiType": "SpecialOffer",
"name": "Summer Special Design",
"externalId": "summer-special-design",
"backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
"title": {
"text": "Limited Time Offer",
"fontColor": {
"colorOne": "#ffffff"
},
"fontSize": 20,
"fontWeight": "bold"
},
"buttonSuffixImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix.png",
"buttonSuffixAnimation": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix-animation.json"
}
Delete Special Offer Design
Deletes a special offer design.
Note: You can’t delete an offer design while it’s in use by an offer.
curl -X DELETE \
'https://api.appcharge.com/components/v1/offer-design/summer-special-design' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-publisher-token: <x-publisher-token>'
{
"id": "68b3f37f3a2852af1a154fae",
"offerUiType": "SpecialOffer",
"name": "Summer Special Design",
"externalId": "summer-special-design",
"backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
"title": {
"text": "Limited Time Offer",
"fontColor": {
"colorOne": "#ffffff"
},
"fontSize": 20,
"fontWeight": "bold"
},
"buttonSuffixImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix.png",
"buttonSuffixAnimation": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix-animation.json"
}
curl -X DELETE \
'https://api.appcharge.com/components/v1/offer-design/summer-special-design' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-publisher-token: <x-publisher-token>'
{
"id": "68b3f37f3a2852af1a154fae",
"offerUiType": "SpecialOffer",
"name": "Summer Special Design",
"externalId": "summer-special-design",
"backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
"title": {
"text": "Limited Time Offer",
"fontColor": {
"colorOne": "#ffffff"
},
"fontSize": 20,
"fontWeight": "bold"
},
"buttonSuffixImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix.png",
"buttonSuffixAnimation": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix-animation.json"
}
Headers
Publisher token, as displayed in the Publisher Dashboard.
Path Parameters
Design ID that you defined.
Response
Special offer design deleted successfully.
Design ID.
"68b3f37f3a2852af1a154fae"
Type of offer design.
SpecialOffer "SpecialOffer"
Offer design name.
"Summer Special Design"
Design ID that you defined.
"summer-special-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"
Button asset suffix for the promotion offer design.
"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix.png"
Button asset suffix animation for the promotion offer design.
"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix-animation.json"
Was this page helpful?