Overview
What's New
Web Store
Checkout
Media
Events Center
curl -X PUT \
'https://api.appcharge.com/v2/offer/rolling-offer-1' \
-H 'Content-Type: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
-d '{
"name": "My New Rolling Offer Name",
"type": "RollingOffer",
"active": true,
"productsSequence": [
{
"index": 1,
"products": [
{
"publisherProductId": "613",
"name": "Sword",
"textFontColorHex": "#f60404",
"type": "Quantity",
"prefix": "$",
"suffix": "M",
"priority": "Main",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/408472.png"
},
{
"type": "productPrefix",
"url": ""
}
],
"createdAt": "2024-03-01T10:14:34.142Z",
"updatedAt": "2025-02-05T13:20:50.759Z",
"displayName": "Sword",
"productId": "25e1aa8a7ef37e0d94b16fdf"
}
],
"priceInUsdCents": 5000
},
{
"index": 2,
"products": [
{
"product": {
"publisherProductId": "614",
"name": "Boost",
"textFontColorHex": "#bfc6e8",
"type": "Quantity",
"prefix": "+",
"suffix": "🎉",
"priority": "Sub",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/1730204644395__99c7d8e4-4658-49db-ac4f-501ab93fee9a"
},
{
"type": "productPrefix",
"url": ""
}
],
"displayName": "Boost",
"createdAt": "2024-10-29T12:24:23.083Z",
"updatedAt": "2025-01-16T09:38:15.446Z",
"productId": "6720d3f7aaca102ce5fb0ce2"
}
}
],
"priceInUsdCents": 3000
}
],
"priority": 1,
"schedule": {
"permanent": false,
"timeFrames": [
{
"startTime": "2025-06-22T12:05:00.000Z",
"endTime": "2025-06-22T12:10:00.000Z",
"notes": "",
"id": "68078610fb23b166fb160469"
}
]
},
"productSale": {
"type": "percentage",
"sale": 100
},
"priceDiscount": {
"type": "percentage",
"discount": 20
},
"displayName": "My Rolling Offer",
"description": "This is my rolling offer description.",
"segments": [
"New User"
]
}'
{
"publisherId": "35nb7861ec9924a6b69a0fe59",
"offerId": "726cff96123a8717",
"publisherOfferId": "rolling-offer-1",
"name": "My New Rolling Offer Name",
"type": "RollingOffer",
"active": true,
"active": true,
"displayName": "My Rolling Offer",
"description": "This is my rolling offer description.",
"segments": [
"New User"
],
"publisherTabId": "tab-1",
"offerUi": null,
"productsSequence": [
{
"index": 1,
"products": [
{
"publisherProductId": "613",
"name": "Sword",
"textFontColorHex": "#f60404",
"type": "Quantity",
"prefix": "$",
"suffix": "M",
"priority": "Main",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/408472.png"
},
{
"type": "productPrefix",
"url": ""
}
],
"createdAt": "2024-03-01T10:14:34.142Z",
"updatedAt": "2025-02-05T13:20:50.759Z",
"displayName": "Sword",
"productId": "25e1aa8a7ef37e0d94b16fdf"
}
],
"priceInUsdCents": 5000
},
{
"index": 2,
"products": [
{
"product": {
"publisherProductId": "614",
"name": "Boost",
"textFontColorHex": "#bfc6e8",
"type": "Quantity",
"prefix": "+",
"suffix": "🎉",
"priority": "Sub",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/1730204644395__99c7d8e4-4658-49db-ac4f-501ab93fee9a"
},
{
"type": "productPrefix",
"url": ""
}
],
"displayName": "Boost",
"createdAt": "2024-10-29T12:24:23.083Z",
"updatedAt": "2025-01-16T09:38:15.446Z",
"productId": "6720d3f7aaca102ce5fb0ce2"
}
}
],
"priceInUsdCents": 3000
}
],
"priority": 1,
"schedule": {
"permanent": false,
"timeFrames": [
{
"startTime": "2025-06-22T12:05:00.000Z",
"endTime": "2025-06-22T12:10:00.000Z",
"notes": "",
"id": "68078610fb23b166fb160469"
}
]
},
"productSale": {
"type": "percentage",
"sale": 100
},
"priceDiscount": {
"type": "percentage",
"discount": 20
},
"createdAt": "2025-04-06T10:00:44.528Z",
"updatedAt": "2025-06-06T10:00:44.528Z"
}
Update Rolling Offer
Updates a rolling offer.
curl -X PUT \
'https://api.appcharge.com/v2/offer/rolling-offer-1' \
-H 'Content-Type: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
-d '{
"name": "My New Rolling Offer Name",
"type": "RollingOffer",
"active": true,
"productsSequence": [
{
"index": 1,
"products": [
{
"publisherProductId": "613",
"name": "Sword",
"textFontColorHex": "#f60404",
"type": "Quantity",
"prefix": "$",
"suffix": "M",
"priority": "Main",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/408472.png"
},
{
"type": "productPrefix",
"url": ""
}
],
"createdAt": "2024-03-01T10:14:34.142Z",
"updatedAt": "2025-02-05T13:20:50.759Z",
"displayName": "Sword",
"productId": "25e1aa8a7ef37e0d94b16fdf"
}
],
"priceInUsdCents": 5000
},
{
"index": 2,
"products": [
{
"product": {
"publisherProductId": "614",
"name": "Boost",
"textFontColorHex": "#bfc6e8",
"type": "Quantity",
"prefix": "+",
"suffix": "🎉",
"priority": "Sub",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/1730204644395__99c7d8e4-4658-49db-ac4f-501ab93fee9a"
},
{
"type": "productPrefix",
"url": ""
}
],
"displayName": "Boost",
"createdAt": "2024-10-29T12:24:23.083Z",
"updatedAt": "2025-01-16T09:38:15.446Z",
"productId": "6720d3f7aaca102ce5fb0ce2"
}
}
],
"priceInUsdCents": 3000
}
],
"priority": 1,
"schedule": {
"permanent": false,
"timeFrames": [
{
"startTime": "2025-06-22T12:05:00.000Z",
"endTime": "2025-06-22T12:10:00.000Z",
"notes": "",
"id": "68078610fb23b166fb160469"
}
]
},
"productSale": {
"type": "percentage",
"sale": 100
},
"priceDiscount": {
"type": "percentage",
"discount": 20
},
"displayName": "My Rolling Offer",
"description": "This is my rolling offer description.",
"segments": [
"New User"
]
}'
{
"publisherId": "35nb7861ec9924a6b69a0fe59",
"offerId": "726cff96123a8717",
"publisherOfferId": "rolling-offer-1",
"name": "My New Rolling Offer Name",
"type": "RollingOffer",
"active": true,
"active": true,
"displayName": "My Rolling Offer",
"description": "This is my rolling offer description.",
"segments": [
"New User"
],
"publisherTabId": "tab-1",
"offerUi": null,
"productsSequence": [
{
"index": 1,
"products": [
{
"publisherProductId": "613",
"name": "Sword",
"textFontColorHex": "#f60404",
"type": "Quantity",
"prefix": "$",
"suffix": "M",
"priority": "Main",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/408472.png"
},
{
"type": "productPrefix",
"url": ""
}
],
"createdAt": "2024-03-01T10:14:34.142Z",
"updatedAt": "2025-02-05T13:20:50.759Z",
"displayName": "Sword",
"productId": "25e1aa8a7ef37e0d94b16fdf"
}
],
"priceInUsdCents": 5000
},
{
"index": 2,
"products": [
{
"product": {
"publisherProductId": "614",
"name": "Boost",
"textFontColorHex": "#bfc6e8",
"type": "Quantity",
"prefix": "+",
"suffix": "🎉",
"priority": "Sub",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/1730204644395__99c7d8e4-4658-49db-ac4f-501ab93fee9a"
},
{
"type": "productPrefix",
"url": ""
}
],
"displayName": "Boost",
"createdAt": "2024-10-29T12:24:23.083Z",
"updatedAt": "2025-01-16T09:38:15.446Z",
"productId": "6720d3f7aaca102ce5fb0ce2"
}
}
],
"priceInUsdCents": 3000
}
],
"priority": 1,
"schedule": {
"permanent": false,
"timeFrames": [
{
"startTime": "2025-06-22T12:05:00.000Z",
"endTime": "2025-06-22T12:10:00.000Z",
"notes": "",
"id": "68078610fb23b166fb160469"
}
]
},
"productSale": {
"type": "percentage",
"sale": 100
},
"priceDiscount": {
"type": "percentage",
"discount": 20
},
"createdAt": "2025-04-06T10:00:44.528Z",
"updatedAt": "2025-06-06T10:00:44.528Z"
}
curl -X PUT \
'https://api.appcharge.com/v2/offer/rolling-offer-1' \
-H 'Content-Type: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
-d '{
"name": "My New Rolling Offer Name",
"type": "RollingOffer",
"active": true,
"productsSequence": [
{
"index": 1,
"products": [
{
"publisherProductId": "613",
"name": "Sword",
"textFontColorHex": "#f60404",
"type": "Quantity",
"prefix": "$",
"suffix": "M",
"priority": "Main",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/408472.png"
},
{
"type": "productPrefix",
"url": ""
}
],
"createdAt": "2024-03-01T10:14:34.142Z",
"updatedAt": "2025-02-05T13:20:50.759Z",
"displayName": "Sword",
"productId": "25e1aa8a7ef37e0d94b16fdf"
}
],
"priceInUsdCents": 5000
},
{
"index": 2,
"products": [
{
"product": {
"publisherProductId": "614",
"name": "Boost",
"textFontColorHex": "#bfc6e8",
"type": "Quantity",
"prefix": "+",
"suffix": "🎉",
"priority": "Sub",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/1730204644395__99c7d8e4-4658-49db-ac4f-501ab93fee9a"
},
{
"type": "productPrefix",
"url": ""
}
],
"displayName": "Boost",
"createdAt": "2024-10-29T12:24:23.083Z",
"updatedAt": "2025-01-16T09:38:15.446Z",
"productId": "6720d3f7aaca102ce5fb0ce2"
}
}
],
"priceInUsdCents": 3000
}
],
"priority": 1,
"schedule": {
"permanent": false,
"timeFrames": [
{
"startTime": "2025-06-22T12:05:00.000Z",
"endTime": "2025-06-22T12:10:00.000Z",
"notes": "",
"id": "68078610fb23b166fb160469"
}
]
},
"productSale": {
"type": "percentage",
"sale": 100
},
"priceDiscount": {
"type": "percentage",
"discount": 20
},
"displayName": "My Rolling Offer",
"description": "This is my rolling offer description.",
"segments": [
"New User"
]
}'
{
"publisherId": "35nb7861ec9924a6b69a0fe59",
"offerId": "726cff96123a8717",
"publisherOfferId": "rolling-offer-1",
"name": "My New Rolling Offer Name",
"type": "RollingOffer",
"active": true,
"active": true,
"displayName": "My Rolling Offer",
"description": "This is my rolling offer description.",
"segments": [
"New User"
],
"publisherTabId": "tab-1",
"offerUi": null,
"productsSequence": [
{
"index": 1,
"products": [
{
"publisherProductId": "613",
"name": "Sword",
"textFontColorHex": "#f60404",
"type": "Quantity",
"prefix": "$",
"suffix": "M",
"priority": "Main",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/408472.png"
},
{
"type": "productPrefix",
"url": ""
}
],
"createdAt": "2024-03-01T10:14:34.142Z",
"updatedAt": "2025-02-05T13:20:50.759Z",
"displayName": "Sword",
"productId": "25e1aa8a7ef37e0d94b16fdf"
}
],
"priceInUsdCents": 5000
},
{
"index": 2,
"products": [
{
"product": {
"publisherProductId": "614",
"name": "Boost",
"textFontColorHex": "#bfc6e8",
"type": "Quantity",
"prefix": "+",
"suffix": "🎉",
"priority": "Sub",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/1730204644395__99c7d8e4-4658-49db-ac4f-501ab93fee9a"
},
{
"type": "productPrefix",
"url": ""
}
],
"displayName": "Boost",
"createdAt": "2024-10-29T12:24:23.083Z",
"updatedAt": "2025-01-16T09:38:15.446Z",
"productId": "6720d3f7aaca102ce5fb0ce2"
}
}
],
"priceInUsdCents": 3000
}
],
"priority": 1,
"schedule": {
"permanent": false,
"timeFrames": [
{
"startTime": "2025-06-22T12:05:00.000Z",
"endTime": "2025-06-22T12:10:00.000Z",
"notes": "",
"id": "68078610fb23b166fb160469"
}
]
},
"productSale": {
"type": "percentage",
"sale": 100
},
"priceDiscount": {
"type": "percentage",
"discount": 20
},
"createdAt": "2025-04-06T10:00:44.528Z",
"updatedAt": "2025-06-06T10:00:44.528Z"
}
Headers
The publisher token used for authentication.
Path Parameters
The rolling offer ID provided by the publisher. This is the offer's External ID value in the Publisher Dashboard.
Body
The name of the rolling offer (at least 3 characters).
The type of offer - In this case 'RollingOffer'.
RollingOffer Whether the rolling offer is active.
The sequence of products included in the rolling offer. A minimum of 2 productSequence objects is required, with a maximum limit of 50 product sequences.
Show child attributes
Show child attributes
The order of the product in the rolling offer. The index must start from 1 and be sequential.
Sub offer display name.
List of products in the rolling offer, with a maximum of 3 per productSequence object.
Show child attributes
Show child attributes
Specifies the display priority of a product within the rolling offer.
Main, Sub The unique ID of the product.
The quantity of the product in the rolling offer.
The price of the product in cents. The value must be either 0 (free), or have a minimum 80 cents.
Sale details for the product (relevant only for paid offers). The sale will only be applied on the first offer.
Internal ID for the Offer UI (required if offerExternalUiId is not provided).
The offer UI ID as configured by the publisher (if provided, offerUiId is not 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.
List of player segments that this rolling offer applies to.
Tab ID in the web store.
The schedule for when the rolling offer is available.
Show child attributes
Show child attributes
Whether the rolling offer is permanent.
Time frame for the scheduled offer. Leave blank if permanent is set to true. If permanent is false, at least 1 time frame is required. When specifying multiple timeFrames, the startTime and endTime of each must not overlap.
Response
Rolling offer updated successfully.
Publisher ID.
The unique identifier of the rolling offer.
The rolling offer ID provided by the publisher. This is the offer's External ID value in the Publisher Dashboard.
The name of the rolling offer.
The type of rolling offer.
Whether the rolling offer is active.
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.
The player segments associated with the rolling offer.
Tab ID in the web store.
Information about the rolling offer design, as configured in the Publisher Dashboard.
Show child attributes
Show child attributes
The ID of the rolling offer design.
Whether the rolling offer design is active.
The type of offer design. In this case, ‘RollingOffer’.
The name of the rolling offer design.
The description of the rolling offer design.
The background image of the rolling offer.
Border color details for the rolling offer.
Show child attributes
Show child attributes
The primary border color.
The secondary border color. Returned only if the border color in the UI is set to Linear.
The direction of the gradient between both border colors. Returned only if the border color in the UI is set to Linear.
The width of the border surrounding the rolling offer.
The SKU of the rolling offer design, as defined in the Publisher Dashboard.
Specific settings for the rolling offer UI, as configured in the Publisher Dashboard.
Show child attributes
Show child attributes
The arrow color.
Information about the background color of the rolling offer.
Show child attributes
Show child attributes
The primary background color of the rolling offer.
The secondary background color of the rolling offer. Returned only if the background color in the UI is set to Linear.
The direction of the gradient between both background colors. Returned only if the background color in the UI is set to Linear.
The header image of the rolling offer.
The opacity level of the rolling offer background.
Information about the sub offer design.
Show child attributes
Show child attributes
Information about the background color of the sub offer.
Show child attributes
Show child attributes
The primary background color of the sub offer.
The secondary background color of the sub offer. Returned only if the background color in the UI is set to Linear.
The direction of the gradient between both background colors. Returned only if the background color in the UI is set to Linear.
The background image of the sub offer.
The image shown when the sub offer is locked.
The text displayed on the button used to claim the sub offer.
The sequence of products within the rolling offer. Min: 2 Max: 50
Show child attributes
Show child attributes
The order of the product in the rolling offer. The index must start from 1 and be sequential.
Sub offer display name.
List of products in the rolling offer. Max: 3
Show child attributes
Show child attributes
The unique ID of the product.
The quantity of the product in the rolling offer.
Specifies the display priority of a product within the rolling offer.
Main, Sub The price of the product in cents. The value must be either 0 (free), or have a minimum 80 cents.
The schedule for when the rolling offer is available.
Show child attributes
Show child attributes
Whether the rolling offer is permanent.
Time frame for the scheduled offer. Leave blank if permanent is set to true. If permanent is false, at least 1 time frame is required. When specifying multiple timeFrames, the startTime and endTime of each must not overlap.
Date the rolling offer was created.
Date the rolling offer was updated.
Was this page helpful?