Sign in

v1

latestOpenAPI 3.1.02026-07-2665153355.3 KB
Rolling Offers

Update an existing rolling offer

put/offering/rolling-offer/{rollingOfferSKU}

Path parameters

publisherOfferIdstring required

The SKU of the rolling offer.

Headers

x-publisher-tokenstring required

The publisher token used for authentication.

Request body

namestring

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

type'RollingOffer' required

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

activeboolean

Whether the rolling offer is active.

offerUiIdstring

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

offerExternalUiIdstring

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

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

List of player segments that this rolling offer applies to.

publisherTabIdstring

Tab ID in the web store.

publisherSectionIdstring

The publisher section ID.

displayNamestring

If not specified, the offer name will be used.

descriptionstring

The offer description.

Response

Rolling offer updated 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.