Sign in

v1

latestOpenAPI 3.1.02026-07-2665153355.3 KB
Triggered Popups

Delete Store Refresh Popup

Deletes a store refresh popup.

delete/v2/offer/{publisherOfferId}

Path parameters

publisherOfferIdstring required
Example:store-refresh-offer-1

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

Headers

x-publisher-tokenstring required

The publisher token

Response

Deleted offer.

publisherIdstring

Publisher ID.

offerIdstring

Store Refresh Popup ID.

publisherOfferIdstring

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

namestring

Store Refresh Popup name.

displayNamestring

Store Refresh Popup display name. If not provided, the name will be used.

descriptionstring

Store Refresh Popup description.

typestring

Offer type.

subTypestring

Offer sub type - In this case 'StoreRefresh'.

activeboolean

Whether the Store Refresh Popup is active.

priorityinteger

Priority level of the Store Refresh Popup.

segmentsstring[]

List of player segments that this Store Refresh Popup applies to.

createdAtstring date-time

Date the Store Refresh Popup was created.

updatedAtstring date-time

Date the Store Refresh Popup was updated.

Example response

{
  "offerUi": {
    "offerUiId": "68b41c5aa1c5b1a284737e9b",
    "offerExternalUiId": "Real_Store_Refresh"
  },
  "productsSequence": [
    {
      "index": 1,
      "products": [
        {
          "publisherProductId": "green_diamond",
          "quantity": 1,
          "priority": "Main"
        }
      ],
      "priceInUsdCents": 99,
      "playerAvailability": 10,
      "hidePlayerAvailability": true
    }
  ],
  "displayRule": {
    "frequency": 3,
    "cooldownInMinutes": 1
  },
  "schedule": {
    "timeFrames": [
      {
        "startTime": "2026-05-02T00:00:00.000Z",
        "endTime": "2026-05-04T23:59:59.000Z",
        "notes": "Initial weekend rollout"
      }
    ]
  },
  "productSale": {
    "sale": 30,
    "type": "percentage"
  },
  "priceDiscount": {
    "discount": 25,
    "type": "percentage"
  },
  "badges": [
    {
      "publisherBadgeId": "best_value"
    }
  ]
}