Offers

DELETE /offering/offer/{publisherOfferId}

Request

The document declares no server URL.
Auth
none required
TypeScript
https://skmtc.dev/appcharge/apis/grant-award/docs/offering/offer/:publisherOfferId/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

publisherOfferIdstring required

Headers

x-publisher-tokenstring required

The publisher token

Response

Delete Offer

publisherIdstring

Publisher ID.

offerIdstring

The SKU of the offer.

publisherOfferIdstring

The offer ID provided by the publisher. This is the offer's External ID value in the Publisher Dashboard.

namestring

The name of the offer. Must be a minimum of 3 characters.

displayNamestring

The display name of the offer.

descriptionstring

The description of the offer (conditionally returned).

typestring

Type of offer.

Available options: Bundle, SpecialOffer, PopUp, RollingOffer, CheckoutLink, ProgressBar

activeboolean

Whether the offer is active.

segmentsstring[]

List of player segments that this offer applies to (e.g., ["NewUser", "BigSpender"]).

publisherTabIdstring

Tab ID in the web store.

startOverboolean

Whether the offer will restart after completion.

prioritynumber

The priority level of the offer. The priority starts from 1, where 1 is the highest priority.

showAfterstring

createdAtstring date-time

Date the offer was created.

updatedAtstring date-time

Date the offer was updated.

Example response

{
  "rewardCalendar": {
    "resetBehavior": "ToCalendarStart",
    "popupTrigger": "ShowAutomatically",
    "rewardCollectionBehavior": "ForcePlayerToCollect"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.