Sign in

v1

latestOpenAPI 3.1.02026-07-2665153355.3 KB
Popups

post/offering/offer/popup

Headers

x-publisher-tokenstring required

The publisher token

Request body

publisherOfferIdstring required

The publisher offer Id.

namestring required

The name of the offer. At least 3 letters.

displayNamestring

The display name of the offer. If not specified, the offer name will be used.

descriptionstring

The description of the offer. Conditionally returned.

typestring required

The type of the offer, in this case 'PopUp'

subTypestring required

The type of popup. In this case 'PostPurchase'

prioritynumber

Choose the priority of the order in which the popups will be displayed, 1 being first

offerUiIdstring 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.

offerExternalUiIdstring

The offer UI ID as configured by the publisher. If offerExternalUiId is provided, then offerUiId will not be required.

activeboolean required

Is the offer active? true/false.

startOverboolean

Whether the popup will repeat itself.

segmentsstring[] 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.

Example request

{
  "publisherOfferId": "offer1",
  "name": "Test_PopUp",
  "description": "Best offer ever.",
  "type": "PopUp",
  "offerUiId": "64a55b82e06998282d3d9b59",
  "offerExternalUiId": "b9c1e7a3d1f8b2a4c6e5d8f3"
}

Response

Create a new Offer

offerIdstring

The Id of the offer.

publisherOfferIdstring

The offer publisher Id.

namestring

The name of the offer.

displayNamestring

The display name of the offer. If not specified, the offer name will be used. Conditonally returned.

descriptionstring

The description of the offer. Conditionally returned.

typestring

The type of the offer. In this case: PopUp.

subTypestring

Price of the products set in cents. Will be returned as 0 if subtype is daily bonus.

createdBystring

The platform which the offer was created from (Dashboard, API)

activeboolean

Is the offer active? true/false.

coolDownInHoursnumber

Used for cooldown between orders. DEPRECATION WARNING: This field will be removed in future releases.

segmentsstring[]

The Ids of the player segments to be used in the segmentation algorithm. for example: [“NewUser”, “BigSpender”].

startOverboolean

Whether the popup will repeat itself.

prioritynumber

Defines the order of priority of for displaying popup.

showAfterstring

Event for which only after the popup appear.

createdAtstring date-time

the time when the offer was created, in UTC.

updatedAtstring date-time

the time when the offer was updated, in UTC.

Example response

{
  "offerId": "655dc8a546822b3e7586b7b7",
  "publisherOfferId": "offer1",
  "name": "Test_PopUp",
  "description": "N/A",
  "type": "PopUp",
  "createdBy": "API",
  "createdAt": "2023-07-05T12:01:06.113Z",
  "updatedAt": "2023-07-05T12:01:06.113Z"
}