Sign in

v1

latestOpenAPI 3.1.02026-07-2665153355.3 KB
Store Refresh Popups

Create a new Store Refresh Popup

Creates a Store Refresh popup offer. Triggered when a player refreshes the web store.

post/v2/offer

Headers

x-publisher-tokenstring required

Publisher token used for authentication.

Request body

publisherOfferIdstring required

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

namestring required

Store Refresh Popup name. Must be at least 3 characters.

displayNamestring

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

descriptionstring

Store Refresh Popup description.

type'PopUp' required

Offer type - In this case 'PopUp'.

subType'StoreRefresh' required

Offer sub type - In this case 'StoreRefresh'.

activeboolean required

Whether the Store Refresh Popup is active.

priorityinteger required

Priority level of the Store Refresh Popup. The priority starts from 1, where 1 is the highest priority.

offerUiIdstring

Offer Design ID generated by Appcharge. This is the design's ID value in the Publisher Dashboard. Required if offerExternalUiId is not provided.

offerExternalUiIdstring

Offer Design ID. This is the design's External ID value in the Publisher Dashboard. Required if offerUiId is not provided.

segmentsstring[] required

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

publisherSectionIdstring

The publisher section ID.

publisherTabIdstring

Tab ID in the web store.

Example request

{
  "type": "PopUp",
  "subType": "StoreRefresh",
  "active": true,
  "publisherOfferId": "store-refresh-offer",
  "name": "Store Refresh Offer",
  "displayName": "Limited time deal",
  "description": "Shown periodically when the store refreshes",
  "segments": [],
  "productsSequence": [
    {
      "index": 1,
      "products": [
        {
          "publisherProductId": "green_diamond",
          "quantity": 1,
          "priority": "Main"
        },
        {
          "publisherProductId": "pink_diamond",
          "quantity": 2,
          "priority": "Main"
        }
      ],
      "priceInUsdCents": 0,
      "playerAvailability": 10,
      "hidePlayerAvailability": true
    }
  ],
  "priority": 5,
  "offerExternalUiId": "Real_Store_Refresh",
  "displayRule": {
    "frequency": 3,
    "cooldownInMinutes": 1
  },
  "schedule": {
    "permanent": false,
    "timeFrames": [
      {
        "startTime": "2026-05-02T00:00:00.000Z",
        "endTime": "2026-05-04T23:59:59.000Z",
        "notes": "Initial weekend rollout"
      },
      {
        "startTime": "2026-05-10T00:00:00.000Z",
        "endTime": "2026-05-12T23:59:59.000Z"
      }
    ]
  },
  "productSale": {
    "sale": 30,
    "type": "percentage"
  },
  "priceDiscount": {
    "discount": 25,
    "type": "percentage"
  },
  "badges": [
    {
      "publisherBadgeId": "best_value"
    }
  ]
}

Response

Store refresh popup created successfully.

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"
    }
  ]
}