--- title: "DELETE /offering/offer/{publisherOfferId}" method: DELETE path: "/offering/offer/{publisherOfferId}" tags: ["Offers"] --- # DELETE /offering/offer/{publisherOfferId} `DELETE /offering/offer/{publisherOfferId}` ## Path parameters - `publisherOfferId` string, required ## Headers - `x-publisher-token` string, required ## Response `200` Delete Offer - OfferDtoResponse - `publisherId` string — Publisher ID. - `offerId` string — The SKU of the offer. - `publisherOfferId` string — The offer ID provided by the publisher. This is the offer's **External ID** value in the Publisher Dashboard. - `name` string — The name of the offer. Must be a minimum of 3 characters. - `displayName` string — The display name of the offer. - `description` string — The description of the offer (conditionally returned). - `type` string — Type of offer. Available options: `Bundle`, `SpecialOffer`, `PopUp`, `RollingOffer`, `CheckoutLink`, `ProgressBar` - `offerUi` OfferUiDto — Details on the offer design, as configured in the Publisher Dashboard. - `offerUiId` string — The ID of the offer design, as displayed in the Publisher Dashboard. - `externalId` string — The SKU of the offer design, as defined in the Publisher Dashboard. - `active` boolean — Whether the offer is active. - `offerUiType` string — The type of offer design. - `name` string — The name of the offer design, as defined in the Publisher Dashboard. - `description` string — The description of the offer design, as defined in the Publisher Dashboard. - `backgroundImage` string — The background image of the offer design, as defined in the Publisher Dashboard. - `specialOffer` object — Details on the offer template and design. - `templateType` string — The template type, as configured in the Publisher Dashboard. - `title` string — The title of the offer, as configured in the Publisher Dashboard. - `fontSize` number — The font size of the offer title, as configured in the Publisher Dashboard. - `fontWeight` string — The font weight of the offer title, as configured in the Publisher Dashboard. - `fontColor` object — Details on the font color of the offer title as configured in the Publisher Dashboard. If the font color is set to linear, direction will be returned, as well as both 'colorOne' and 'colorTwo'. - `colorOne` string — The font color of the offer title. - `colorTwo` string — The second font color of the offer title. Relevant only if the font color is set to linear. - `direction` string — The direction of the linear gradient. Relevant only if the font color is set to linear. - `backgroundColor` object — Details on the background color of the offer title as configured in the Publisher Dashboard. If the background color is set to linear, the direction will be returned along with ‘colorOne’ and ‘colorTwo’. - `colorOne` string — The background color of the offer title. - `colorTwo` string — The second background color of the offer title. Relevant only if the background color is set to linear. - `direction` string — The direction of the linear gradient. Relevant only if the background color is set to linear. - `badges` object[] — List of badges associated with the offer. - `publisherBadgeId` string — The ID as configured in the dashboard. - `productSale` object — Sale details for products in the offer. The sale will only be applied on the first offer. - `sale` integer — The sale percentage applied to the product quanitity. - `type` 'percentage' | 'multiplier' | 'fixed_amount' — The type of sale. - `priceDiscount` object — Discount applied to the price. - `discount` integer — The discount percentage applied. - `type` 'percentage' — The type of discount applied. - `active` boolean — Whether the offer is active. - `segments` string[] — List of player segments that this offer applies to (e.g., ["NewUser", "BigSpender"]). - `publisherTabId` string — Tab ID in the web store. - `productsSequence` object[] — The sequence of products included in the offer. - `index` integer — The order of the product in the offer. - `playerAvailability` number — The number of times a player can purchase or collect the offer. - `hidePlayerAvailability` boolean — Whether to hide the availability text based on the `playerAvailability` property value in the web store. Only relevant for Special Offers and Store Refresh Popups. - `priceInUsdCents` integer — The price of the product in cents. The value must be either 0 (free), or by minimum 80 cents. - `products` object[] — List of products in the offer. - `quantity` integer — The quantity of the product in the offer. - `priority` string — Specifies the display priority of a product within the offer. Either `Main` or `Sub`. - `product` object — Details on the product design. - `publisherProductId` string — The SKU of the product, as configured in the Publisher Dashboard. - `name` string — The name of the product, as configured in the Publisher Dashboard. - `textFontColorHex` string — The font color of the product display name, as configured in the Publisher Dashboard. - `type` 'quantity' | 'time' — Type of product, either quantity or time. - `prefix` string — The prefix of the product, as configured in the Publisher Dashboard. This is the text that appears before the product amount. - `suffix` string — The suffix of the product, as configured in the Publisher Dashboard. This is the text that appears after the product amount. - `priority` 'Main' | 'Sub' — Specifies the display priority of a product within the offer. - `images` object[] — Details on the images uploaded for this product in the Publisher Dashboard. - `type` string — The type of image uploaded for this product in the Publisher Dashboard. - `url` string, uri — The URL of the image that has been uploaded for this product, as generated in the Publisher Dashboard. - `createdAt` string, date-time — Date the product was created. - `updatedAt` string, date-time — Date the product was updated. - `productId` string — A unique product ID number automatically generated by Appcharge. - `progressBarPoints` object[] — List of Progress Bar offers to which this offer contributes points. - `publisherBarId` string — The Progress Bar offer ID provided by the publisher. This is the Progress Bar offer's **External ID** value in the Publisher Dashboard. - `points` number — The number of points this offer contributes to the specified Progress Bar. - `startOver` boolean — Whether the offer will restart after completion. - `rewardCalendar` RewardCalendarBehavior — Information about the Reward Calendar behavior configuration. - `resetBehavior` 'ToCalendarStart' | 'ToCurrentWeekStart', required — Controls how player progress resets after a missed day. - `popupTrigger` 'ShowAutomatically' | 'ShowOnBadgeClick', required — Controls how the Reward Calendar popup opens. - `rewardCollectionBehavior` 'ForcePlayerToCollect' | 'PlayerCanSkipCollection', required — Controls whether players must collect a reward immediately or can collect it later that day. If you pass `ForcePlayerToCollect`, the collectible badge is not shown. - `priority` number — The priority level of the offer. The priority starts from 1, where 1 is the highest priority. - `showAfter` string - `triggers` object[] — An array of objects that define the conditions for triggering the offer. - `type` string — Type of trigger. - `eventName` string — Name of the event that triggered the offer. - `every` integer — Number of purchases required to present the offer. - `rules` unknown[] — Rules that define when the offer will appear. - unknown - `createdAt` string, date-time — Date the offer was created. - `updatedAt` string, date-time — Date the offer was updated. ## Other responses - `401` — Not Authorized --- [API](https://skmtc.net/appcharge/apis/grant-award.md) · [All operations](https://skmtc.net/appcharge/apis/grant-award/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/appcharge/grant-award/versions/b4f6759240d5/schema)