Sign in

v1

latestOpenAPI 3.1.02026-07-2665153355.3 KB
Offers

post/offering/offer

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

If not specified, the offer name will be used

descriptionstring

The description of the offer (conditionally returned)

typestring required

The type of the offer - Bundle, SpecialOffer

offerUiIdstring

Internal ID for the Offer UI (required if offerExternalUiId not provided)

offerExternalUiIdstring

The offer UI ID as configured by the publisher (if provided, offerUiId is not required)

publisherSectionIdstring

The publisher section ID (applies only to Bundle)

activeboolean required

Whether the offer is active

segmentsstring[] required

IDs of player segments (["NewUser", "BigSpender"] etc.)

Response

Create a new 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"
  }
}