Skip to main content
POST
/
v2
/
offer
  curl -X POST \
  'https://api.appcharge.com/v2/offer' \
  -H 'Content-Type: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -d '{
      "publisherOfferId": "rolling-offer-1",
      "name": "My Rolling Offer",
      "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"
      ],
      "publisherTabId": "tab-1"
      }'

{
  "publisherId": "35nb7861ec9924a6b69a0fe59",
  "offerId": "726cff96123a8717",
  "publisherOfferId": "rolling-offer-1",
  "name": "My Rolling Offer",
  "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-04-06T10:00:44.528Z"
}

  curl -X POST \
  'https://api.appcharge.com/v2/offer' \
  -H 'Content-Type: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -d '{
      "publisherOfferId": "rolling-offer-1",
      "name": "My Rolling Offer",
      "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"
      ],
      "publisherTabId": "tab-1"
      }'

{
  "publisherId": "35nb7861ec9924a6b69a0fe59",
  "offerId": "726cff96123a8717",
  "publisherOfferId": "rolling-offer-1",
  "name": "My Rolling Offer",
  "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-04-06T10:00:44.528Z"
}

Headers

​
x-publisher-token
string
required

The publisher token used for authentication.

Body

application/json
​
publisherOfferId
string
required

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

​
name
string
required

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

​
type
enum<string>
required

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

Available options:
RollingOffer
​
active
boolean
required

Whether the rolling offer is active.

​
productsSequence
object[]
required

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.

​
offerUiId
string

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

​
offerExternalUiId
string

The offer UI ID as configured in the Publisher Dashboard.

​
priority
integer

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.

​
publisherTabId
string

Tab ID in the web store.

​
segments
string[]

List of player segments that this rolling offer applies to.

​
schedule
object

The schedule for when the rolling offer is available.

Response

Rolling offer created successfully.

​
publisherId
string

Publisher ID.

​
offerId
string

The unique identifier of the rolling offer.

​
publisherOfferId
string

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

​
name
string

The name of the rolling offer.

​
type
string

The type of rolling offer.

​
active
boolean

Whether the rolling offer is active.

​
priority
integer

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.

​
segments
string[]

The player segments associated with the rolling offer.

​
publisherTabId
string

Tab ID in the web store.

​
offerUi
object

Information about the rolling offer design, as configured in the Publisher Dashboard.

​
productsSequence
object[]

The sequence of products within the rolling offer. Min: 2 Max: 50

​
schedule
object

The schedule for when the rolling offer is available.

​
createdAt
string<date-time>

Date the rolling offer was created.

​
updatedAt
string<date-time>

Date the rolling offer was updated.