Overview
What's New
Web Store
- Player Authentication
- Offers
- Offers V1 API
- Offers V2 API
- Introduction
- Bundles
- Special Offers
- Rolling Offers
- Popups
- Checkout Link Offers
- GETGet Offers
- DELDelete Offers
- Personalization
- Webhooks
Checkout
- Checkout Session
- Orders
- Finance and Analytics
- Checkout Webhooks
Events Center
- Introduction
- Login Events
- Store Interaction Events
- Error Events
- Order Events
- Refund and Dispute Events
Offers V2 API
Delete Offers
Deletes an offer.
DELETE
/
v2
/
offer
/
$
{offerId}
Copy
curl --request DELETE \
--url 'https://api-sandbox.appcharge.com/v2/offer/${offerId}' \
--header 'x-publisher-token: <x-publisher-token>'
Copy
{
"offerId": "<string>",
"publisherOfferId": "<string>",
"name": "<string>",
"displayName": "<string>",
"description": "<string>",
"type": "<string>",
"offerUi": {
"offerUiId": "<string>",
"externalId": "<string>",
"active": true,
"offerUiType": "<string>",
"name": "<string>",
"description": "<string>",
"backgroundImage": "<string>",
"specialOffer": {
"templateType": "<string>",
"title": "<string>",
"fontSize": 123,
"fontWeight": "<string>",
"fontColor": {
"colorOne": "<string>",
"colorTwo": "<string>",
"direction": "<string>"
},
"backgroundColor": {
"colorOne": "<string>",
"colorTwo": "<string>",
"direction": "<string>"
}
}
},
"badges": [
{
"publisherBadgeId": "<string>"
}
],
"productSale": {
"sale": 123,
"type": "percentage"
},
"priceDiscount": {
"discount": 123,
"type": "percentage"
},
"active": true,
"segments": [
"<string>"
],
"productsSequence": [
{
"index": 123,
"playerAvailability": 123,
"priceInUsdCents": 123,
"products": [
{
"quantity": 123,
"priority": "<string>",
"product": {
"publisherProductId": "<string>",
"name": "<string>",
"textFontColorHex": "<string>",
"type": "quantity",
"prefix": "<string>",
"suffix": "<string>",
"priority": "Main",
"images": [
{
"type": "<string>",
"url": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"productId": "<string>"
}
}
]
}
],
"startOver": true,
"priority": 123,
"showAfter": "<string>",
"triggers": [
{
"type": "<string>",
"eventName": "<string>",
"every": 123,
"rules": [
"<any>"
]
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
Headers
The publisher token
Path Parameters
The SKU of the offer.
Response
200
application/json
Deleted offer.
The response is of type object
.
Was this page helpful?
Copy
curl --request DELETE \
--url 'https://api-sandbox.appcharge.com/v2/offer/${offerId}' \
--header 'x-publisher-token: <x-publisher-token>'
Copy
{
"offerId": "<string>",
"publisherOfferId": "<string>",
"name": "<string>",
"displayName": "<string>",
"description": "<string>",
"type": "<string>",
"offerUi": {
"offerUiId": "<string>",
"externalId": "<string>",
"active": true,
"offerUiType": "<string>",
"name": "<string>",
"description": "<string>",
"backgroundImage": "<string>",
"specialOffer": {
"templateType": "<string>",
"title": "<string>",
"fontSize": 123,
"fontWeight": "<string>",
"fontColor": {
"colorOne": "<string>",
"colorTwo": "<string>",
"direction": "<string>"
},
"backgroundColor": {
"colorOne": "<string>",
"colorTwo": "<string>",
"direction": "<string>"
}
}
},
"badges": [
{
"publisherBadgeId": "<string>"
}
],
"productSale": {
"sale": 123,
"type": "percentage"
},
"priceDiscount": {
"discount": 123,
"type": "percentage"
},
"active": true,
"segments": [
"<string>"
],
"productsSequence": [
{
"index": 123,
"playerAvailability": 123,
"priceInUsdCents": 123,
"products": [
{
"quantity": 123,
"priority": "<string>",
"product": {
"publisherProductId": "<string>",
"name": "<string>",
"textFontColorHex": "<string>",
"type": "quantity",
"prefix": "<string>",
"suffix": "<string>",
"priority": "Main",
"images": [
{
"type": "<string>",
"url": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"productId": "<string>"
}
}
]
}
],
"startOver": true,
"priority": 123,
"showAfter": "<string>",
"triggers": [
{
"type": "<string>",
"eventName": "<string>",
"every": 123,
"rules": [
"<any>"
]
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
Assistant
Responses are generated using AI and may contain mistakes.