Headers
The publisher token used for authentication.
Path Parameters
The special offer ID provided by the publisher. This is the offer's External ID value in the Publisher Dashboard.
Body
The name of the special offer (at least 3 characters).
The type of offer - In this case 'SpecialOffer'.
SpecialOffer Whether the special offer is active.
List of player segments that this special offer applies to (e.g., ["NewUser", "BigSpender"]). This is empty by default.
The sequence of products included in the special offer. Only one Products Sequence is allowed.
If not specified, the special offer name will be used.
The description of the offer (conditionally returned).
Internal ID for the Offer UI (required if offerExternalUiId not provided).
The offer UI ID as configured by the publisher (if provided, offerUiId is not required).
Tab ID in the web store.
List of badges associated with the special offer.
Sale details for products in the special offer. The sale will only be applied on the first offer.
Discount applied to the special offer price.
The schedule for when the special offer is available.
Response
Special offer updated successfully.
Publisher ID.
The unique identifier of the special offer.
The special offer ID provided by the publisher. This is the offer's External ID value in the Publisher Dashboard.
The name of the special offer.
The display name of the special offer.
The description of the offer (conditionally returned)
The type of special offer.
Whether the special offer is active.
List of player segments that this special offer applies to (e.g., ["NewUser", "BigSpender"]). This is empty by default.
Tab ID in the web store.
UI configuration for the special offer.
A sequence of products in the special offer.
List of badges associated with the special offer.
Sale details for products in the special offer. The sale will only be applied on the first offer.
Discount applied to the special offer price.
The schedule for when the special offer is available.
Date the special offer was created.
Date the special offer was updated.
