---
title: "POST /offering/offer/popup"
method: POST
path: "/offering/offer/popup"
tags: ["Popups"]
---

# POST /offering/offer/popup

`POST /offering/offer/popup`

## Headers

- `x-publisher-token` string, required

## Request body

- CreatePopupDto
  - `publisherOfferId` string, required — The publisher offer Id.
  - `name` string, required — The name of the offer. At least 3 letters.
  - `displayName` string — The display name of the offer. If not specified, the offer name will be used.
  - `description` string — The description of the offer. Conditionally returned.
  - `type` string, required — The type of the offer, in this case 'PopUp'
  - `subType` string, required — The type of popup. In this case 'PostPurchase'
  - `priority` number — Choose the priority of the order in which the popups will be displayed, 1 being first
  - `offerUiId` string, required — The Internal ID for the Offer UI. The Offer UI is responsible to add UI elements to the offers such as background image and title. Once you create the Offer UI using the dashboard, you will get the internal ID.
  - `offerExternalUiId` string — The offer UI ID as configured by the publisher. If offerExternalUiId is provided, then offerUiId will not be required.
  - `active` boolean, required — Is the offer active? true/false.
  - `startOver` boolean — Whether the popup will repeat itself.
  - `triggers` object[], required — An array of objects specifying the conditions under which the popup should be triggered.
    - `type` 'event' — Type of trigger.
    - `eventName` 'purchase' — Name of the event that triggers the popup.
    - `every` integer — Number of purchases required to present the popup.
    - `rules` object[] — Rules to specify conditions under which the popup appears. If it can apply to any offers, leave the array empty.
      - `fieldName` 'publisherOfferId' — Name of the field to evaluate.
      - `operator` 'in' — Operator to compare the field value.
      - `value` string[] — Array of 'publisherOfferId'(s)
  - `segments` string[], required — The Ids of the player segments to be used in the segmentation algorithm. for example: [“NewUser”, “BigSpender”]. This param is required but can be left empty.
  - `productsSequence` ProductsSequence[], required — An array of product sequences. Only one product sequence is allowed.
    - `index` number, required
    - `priceInUsdCents` number, required
    - `playerAvailability` number
    - `products` ProductsSet[], required
      - `quantity` number, required
      - `publisherProductId` string, required

## Response `201`

Create a new Offer

- PopupDtoResponse
  - `offerId` string — The Id of the offer.
  - `publisherOfferId` string — The offer publisher Id.
  - `name` string — The name of the offer.
  - `displayName` string — The display name of the offer. If not specified, the offer name will be used. Conditonally returned.
  - `description` string — The description of the offer. Conditionally returned.
  - `type` string — The type of the offer. In this case: PopUp.
  - `subType` string — Price of the products set in cents. Will be returned as 0 if subtype is daily bonus.
  - `createdBy` string — The platform which the offer was created from (Dashboard, API)
  - `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.
  - `active` boolean — Is the offer active? true/false.
  - `coolDownInHours` number — Used for cooldown between orders. **DEPRECATION WARNING**: This field will be removed in future releases.
  - `segments` string[] — The Ids of the player segments to be used in the segmentation algorithm. for example: [“NewUser”, “BigSpender”].
  - `productsSequence` ProductsSequenceResponse[] — An array of product sequences. Only one product sequence is allowed.
    - `index` number
    - `playerAvailability` number
    - `priceInUsdCents` number
    - `products` ProductsSetResponse[]
      - `quantity` number
      - `product` ProductDto
        - `publisherProductId` string
        - `name` string
        - `textFontColorHex` string
        - `type` string
        - `prefix` string
        - `suffix` string
        - `priority` string
        - `images` object[]
          - `type` string
          - `url` string
        - `createdAt` string, date-time
        - `updatedAt` string, date-time
        - `productId` string
  - `startOver` boolean — Whether the popup will repeat itself.
  - `priority` number — Defines the order of priority of for displaying popup.
  - `showAfter` string — Event for which only after the popup appear.
  - `triggers` object[] — An array of objects specifying the conditions under which the popup should be triggered.
    - `type` 'event' — Type of trigger.
    - `eventName` 'purchase' — Name of the event that triggers the popup.
    - `every` integer — Number of purchases required to present the popup.
    - `rules` object[] — Rules to specify conditions under which the popup appears. If it can apply to any offers, leave the array empty.
      - `fieldName` 'publisherOfferId' — Name of the field to evaluate.
      - `operator` 'in' — Operator to compare the field value.
      - `value` string[] — Array of 'publisherOfferId'(s)
  - `createdAt` string, date-time — the time when the offer was created, in UTC.
  - `updatedAt` string, date-time — the time when the offer was updated, in UTC.

## Other responses

- `400` — Bad request
- `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/revisions/b4f6759240d5/schema)