APappcharge
Rolling Offers

Create a new rolling offer

post/offering/rolling-offer

Request

Headers

x-publisher-tokenstring required

The publisher token used for authentication.

Request body

publisherOfferIdstring required

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

namestring required

The name of the rolling offer (at least 3 characters).

type'RollingOffer' required

The type of offer - In this case 'RollingOffer'.

activeboolean required

Whether the rolling offer is active.

offerUiIdstring

Internal ID of the Offer UI. Required if offerExternalUiId is not provided.

offerExternalUiIdstring

The offer UI ID as configured in the Publisher Dashboard.

priorityinteger required

The priority level of the rolling offer. The priority starts from 1, where 1 is the highest priority. Important: Only the rolling offer with the highest priority will be returned. Rolling offers with the same or no priority will be sorted by createdAt date in ascending order.

publisherTabIdstring

Tab ID in the web store.

segmentsstring[] required

List of player segments that this rolling offer applies to.

publisherSectionIdstring

The publisher section ID.

displayNamestring

If not specified, the offer name will be used.

descriptionstring

The offer description.

Response

Rolling offer created successfully.

publisherIdstring

Publisher ID.

offerIdstring

The unique identifier of the rolling offer.

publisherOfferIdstring

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

namestring

The name of the rolling offer.

typestring

The type of rolling offer.

activeboolean

Whether the rolling offer is active.

priorityinteger

The priority level of the rolling offer. The priority starts from 1, where 1 is the highest priority. Important: Only the rolling offer with the highest priority will be returned. Rolling offers with the same or no priority will be sorted by createdAt date in ascending order.

segmentsstring[]

The player segments associated with the rolling offer.

publisherTabIdstring

Tab ID in the web store.

createdAtstring date-time

Date the rolling offer was created.

updatedAtstring date-time

Date the rolling offer was updated.

Changes

No recorded changes to this operation across all 1 revision of this API.