Skip to main content
POST
/
v2
/
offer
curl -X POST \
  'https://api.appcharge.com/v2/offer' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -d '{
    "publisherOfferId": "reward-calendar-1",
    "name": "Weekly Reward Calendar",
    "type": "PopUp",
    "subType": "RewardCalendar",
    "active": true,
    "priority": 1,
    "offerExternalUiId": "reward-calendar-design-1",
    "startOver": false,
    "rewardCalendar": {
      "resetBehavior": "ToCalendarStart",
      "popupTrigger": "ShowAutomatically",
      "rewardCollectionBehavior": "ForcePlayerToCollect"
    },
    "productsSequence": [
      {
        "index": 1,
        "products": [
          {
            "publisherProductId": "coins",
            "quantity": 100,
            "priority": "Sub"
          }
        ],
        "priceInUsdCents": 0
      },
      {
        "index": 2,
        "products": [
          {
            "publisherProductId": "coins",
            "quantity": 150,
            "priority": "Sub"
          }
        ],
        "priceInUsdCents": 0
      },
      {
        "index": 3,
        "products": [
          {
            "publisherProductId": "coins",
            "quantity": 200,
            "priority": "Sub"
          }
        ],
        "priceInUsdCents": 0
      },
      {
        "index": 4,
        "products": [
          {
            "publisherProductId": "coins",
            "quantity": 250,
            "priority": "Sub"
          }
        ],
        "priceInUsdCents": 0
      },
      {
        "index": 5,
        "products": [
          {
            "publisherProductId": "coins",
            "quantity": 300,
            "priority": "Sub"
          }
        ],
        "priceInUsdCents": 0
      },
      {
        "index": 6,
        "products": [
          {
            "publisherProductId": "coins",
            "quantity": 350,
            "priority": "Sub"
          }
        ],
        "priceInUsdCents": 0
      },
      {
        "index": 7,
        "products": [
          {
            "publisherProductId": "chest",
            "quantity": 1,
            "priority": "Main"
          }
        ],
        "priceInUsdCents": 0
      }
    ],
    "segments": [
      "New User"
    ]
  }'

{
  "publisherId": "69133d595af23405d88843a5",
  "publisherOfferId": "reward-calendar-1",
  "name": "Weekly Reward Calendar",
  "displayName": "Weekly Reward Calendar",
  "type": "PopUp",
  "subType": "RewardCalendar",
  "active": true,
  "segments": [
    "New User"
  ],
  "offerUi": {
    "offerUiId": "6a1828e5e75e5598d942e257",
    "active": true,
    "offerUiType": "PopUp",
    "offerUiSubType": "RewardCalendar",
    "name": "Weekly Reward Calendar Design",
    "description": "description",
    "backgroundImage": "",
    "rewardCalendar": {
      "collectibleBadgeImage": "https://media.appcharge.com/defaults/reward-calendar/reward_badge.png",
      "lockedBadgeImage": "https://media.appcharge.com/defaults/reward-calendar/reward_badge_locked.png",
      "dayFontColor": "#764cd4",
      "subRewardBackgroundImage": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1779967290083__9f0c1502-10e0-4b75-a670-3748c2ebbdf1",
      "mainRewardBackgroundImage": "",
      "backgroundColor": "#97daf4",
      "headerImage": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1779966861904__a16963b5-db9b-45de-b5c5-cdcc7dcf79f3",
      "collectIconImage": "https://media.appcharge.com/defaults/reward-calendar/default_collected_icon.png",
      "lockedIconImage": "https://media.appcharge.com/defaults/reward-calendar/default_lock_icon.png"
    },
    "externalId": "reward-calendar-design-1"
  },
  "productsSequence": [
    {
      "index": 1,
      "products": [
        {
          "product": {
            "publisherProductId": "coins",
            "name": "Coins",
            "description": "Coins reward.",
            "textFontColorHex": "#FFFFFF",
            "type": "Quantity",
            "prefix": "",
            "suffix": "",
            "images": [
              {
                "type": "product",
                "url": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1770287158114__a4266bfc-297f-47c9-b5e5-16d7fdb987ea"
              },
              {
                "type": "productPrefix",
                "url": ""
              }
            ],
            "displayName": "Coins",
            "createdAt": "2026-02-05T10:26:12.307Z",
            "updatedAt": "2026-02-05T10:26:12.307Z",
            "productId": "698470440b0547d86762f85e"
          },
          "publisherProductId": "coins",
          "quantity": 100,
          "priority": "Sub"
        }
      ],
      "priceInUsdCents": 0,
      "badges": []
    },
    {
      "index": 2,
      "products": [
        {
          "product": {
            "publisherProductId": "coins",
            "name": "Coins",
            "description": "Coins reward.",
            "textFontColorHex": "#FFFFFF",
            "type": "Quantity",
            "prefix": "",
            "suffix": "",
            "images": [
              {
                "type": "product",
                "url": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1762940780865__0f4b7e05-6051-46c8-9160-d155e9ca2c3b"
              },
              {
                "type": "productPrefix",
                "url": ""
              }
            ],
            "displayName": "Coins",
            "createdAt": "2025-11-12T09:46:28.925Z",
            "updatedAt": "2025-11-12T09:46:28.925Z",
            "productId": "69145774cceb99de11dfe64a"
          },
          "publisherProductId": "coins",
          "quantity": 150,
          "priority": "Sub"
        }
      ],
      "priceInUsdCents": 0,
      "badges": []
    },
    {
      "index": 3,
      "products": [
        {
          "product": {
            "publisherProductId": "coins",
            "name": "Coins",
            "description": "Coins reward.",
            "textFontColorHex": "#FFFFFF",
            "type": "Quantity",
            "prefix": "",
            "suffix": "",
            "images": [
              {
                "type": "product",
                "url": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1762940945510__6d0b0fbd-1833-4f01-b230-421a5f4bdba9"
              },
              {
                "type": "productPrefix",
                "url": ""
              }
            ],
            "displayName": "Coins",
            "createdAt": "2025-11-12T09:49:10.063Z",
            "updatedAt": "2025-11-12T09:49:10.063Z",
            "productId": "69145816cceb99de11dfe692"
          },
          "publisherProductId": "coins",
          "quantity": 200,
          "priority": "Sub"
        }
      ],
      "priceInUsdCents": 0,
      "badges": []
    },
    {
      "index": 4,
      "products": [
        {
          "product": {
            "publisherProductId": "coins",
            "name": "Coins",
            "description": "Coins reward.",
            "textFontColorHex": "#FFFFFF",
            "type": "Quantity",
            "prefix": "",
            "suffix": "",
            "images": [
              {
                "type": "product",
                "url": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1763013669345__fda4f44a-19e6-4a9a-b71a-9e55903dfece"
              },
              {
                "type": "productPrefix",
                "url": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1763013758566__745ba5f4-582f-401f-b9fe-08cd218bf778"
              }
            ],
            "createdAt": "2025-11-11T13:42:51.928Z",
            "updatedAt": "2025-11-13T06:02:42.481Z",
            "displayName": "Coins",
            "productId": "69133d5bcceb99de11df0200"
          },
          "publisherProductId": "coins",
          "quantity": 250,
          "priority": "Sub"
        }
      ],
      "priceInUsdCents": 0,
      "badges": []
    },
    {
      "index": 5,
      "products": [
        {
          "product": {
            "publisherProductId": "coins",
            "name": "Coins",
            "description": "Coins reward.",
            "textFontColorHex": "#FFFFFF",
            "type": "Quantity",
            "prefix": "",
            "suffix": "",
            "images": [
              {
                "type": "product",
                "url": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1770287224409__a406068e-4153-4f75-93b9-ea884d6fac82"
              },
              {
                "type": "productPrefix",
                "url": ""
              }
            ],
            "displayName": "Coins",
            "createdAt": "2026-02-05T10:27:18.553Z",
            "updatedAt": "2026-02-05T10:27:18.553Z",
            "productId": "6984708615abbcb66f201dbe"
          },
          "publisherProductId": "coins",
          "quantity": 300,
          "priority": "Sub"
        }
      ],
      "priceInUsdCents": 0,
      "badges": []
    },
    {
      "index": 6,
      "products": [
        {
          "product": {
            "publisherProductId": "coins",
            "name": "Coins",
            "description": "Coins reward.",
            "textFontColorHex": "#FFFFFF",
            "type": "Quantity",
            "prefix": "",
            "suffix": "",
            "images": [
              {
                "type": "product",
                "url": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1770287198121__4f7c17dc-7a12-4554-89b2-dd90c51e8114"
              },
              {
                "type": "productPrefix",
                "url": ""
              }
            ],
            "displayName": "Coins",
            "createdAt": "2026-02-05T10:26:41.716Z",
            "updatedAt": "2026-02-05T10:26:41.716Z",
            "productId": "6984706115abbcb66f201dae"
          },
          "publisherProductId": "coins",
          "quantity": 350,
          "priority": "Sub"
        }
      ],
      "priceInUsdCents": 0,
      "badges": []
    },
    {
      "index": 7,
      "products": [
        {
          "product": {
            "publisherProductId": "chest",
            "name": "Chest",
            "description": "Chest reward.",
            "textFontColorHex": "#FFFFFF",
            "type": "Quantity",
            "prefix": "",
            "suffix": "",
            "images": [
              {
                "type": "product",
                "url": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1770287158114__a4266bfc-297f-47c9-b5e5-16d7fdb987ea"
              },
              {
                "type": "productPrefix",
                "url": ""
              }
            ],
            "displayName": "Chest",
            "createdAt": "2026-02-05T10:26:12.307Z",
            "updatedAt": "2026-02-05T10:26:12.307Z",
            "productId": "698470440b0547d86762f85e"
          },
          "publisherProductId": "chest",
          "quantity": 1,
          "priority": "Main"
        }
      ],
      "priceInUsdCents": 0,
      "badges": []
    }
  ],
  "priority": 1,
  "startOver": false,
  "rewardCalendar": {
    "resetBehavior": "ToCalendarStart",
    "popupTrigger": "ShowAutomatically",
    "rewardCollectionBehavior": "ForcePlayerToCollect"
  },
  "badges": [],
  "createdAt": "2026-06-11T05:09:03.575Z",
  "updatedAt": "2026-06-11T05:09:03.575Z",
  "offerId": "6a2a42ef85ce5ccba45444f3"
}

curl -X POST \
  'https://api.appcharge.com/v2/offer' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -d '{
    "publisherOfferId": "reward-calendar-1",
    "name": "Weekly Reward Calendar",
    "type": "PopUp",
    "subType": "RewardCalendar",
    "active": true,
    "priority": 1,
    "offerExternalUiId": "reward-calendar-design-1",
    "startOver": false,
    "rewardCalendar": {
      "resetBehavior": "ToCalendarStart",
      "popupTrigger": "ShowAutomatically",
      "rewardCollectionBehavior": "ForcePlayerToCollect"
    },
    "productsSequence": [
      {
        "index": 1,
        "products": [
          {
            "publisherProductId": "coins",
            "quantity": 100,
            "priority": "Sub"
          }
        ],
        "priceInUsdCents": 0
      },
      {
        "index": 2,
        "products": [
          {
            "publisherProductId": "coins",
            "quantity": 150,
            "priority": "Sub"
          }
        ],
        "priceInUsdCents": 0
      },
      {
        "index": 3,
        "products": [
          {
            "publisherProductId": "coins",
            "quantity": 200,
            "priority": "Sub"
          }
        ],
        "priceInUsdCents": 0
      },
      {
        "index": 4,
        "products": [
          {
            "publisherProductId": "coins",
            "quantity": 250,
            "priority": "Sub"
          }
        ],
        "priceInUsdCents": 0
      },
      {
        "index": 5,
        "products": [
          {
            "publisherProductId": "coins",
            "quantity": 300,
            "priority": "Sub"
          }
        ],
        "priceInUsdCents": 0
      },
      {
        "index": 6,
        "products": [
          {
            "publisherProductId": "coins",
            "quantity": 350,
            "priority": "Sub"
          }
        ],
        "priceInUsdCents": 0
      },
      {
        "index": 7,
        "products": [
          {
            "publisherProductId": "chest",
            "quantity": 1,
            "priority": "Main"
          }
        ],
        "priceInUsdCents": 0
      }
    ],
    "segments": [
      "New User"
    ]
  }'

{
  "publisherId": "69133d595af23405d88843a5",
  "publisherOfferId": "reward-calendar-1",
  "name": "Weekly Reward Calendar",
  "displayName": "Weekly Reward Calendar",
  "type": "PopUp",
  "subType": "RewardCalendar",
  "active": true,
  "segments": [
    "New User"
  ],
  "offerUi": {
    "offerUiId": "6a1828e5e75e5598d942e257",
    "active": true,
    "offerUiType": "PopUp",
    "offerUiSubType": "RewardCalendar",
    "name": "Weekly Reward Calendar Design",
    "description": "description",
    "backgroundImage": "",
    "rewardCalendar": {
      "collectibleBadgeImage": "https://media.appcharge.com/defaults/reward-calendar/reward_badge.png",
      "lockedBadgeImage": "https://media.appcharge.com/defaults/reward-calendar/reward_badge_locked.png",
      "dayFontColor": "#764cd4",
      "subRewardBackgroundImage": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1779967290083__9f0c1502-10e0-4b75-a670-3748c2ebbdf1",
      "mainRewardBackgroundImage": "",
      "backgroundColor": "#97daf4",
      "headerImage": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1779966861904__a16963b5-db9b-45de-b5c5-cdcc7dcf79f3",
      "collectIconImage": "https://media.appcharge.com/defaults/reward-calendar/default_collected_icon.png",
      "lockedIconImage": "https://media.appcharge.com/defaults/reward-calendar/default_lock_icon.png"
    },
    "externalId": "reward-calendar-design-1"
  },
  "productsSequence": [
    {
      "index": 1,
      "products": [
        {
          "product": {
            "publisherProductId": "coins",
            "name": "Coins",
            "description": "Coins reward.",
            "textFontColorHex": "#FFFFFF",
            "type": "Quantity",
            "prefix": "",
            "suffix": "",
            "images": [
              {
                "type": "product",
                "url": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1770287158114__a4266bfc-297f-47c9-b5e5-16d7fdb987ea"
              },
              {
                "type": "productPrefix",
                "url": ""
              }
            ],
            "displayName": "Coins",
            "createdAt": "2026-02-05T10:26:12.307Z",
            "updatedAt": "2026-02-05T10:26:12.307Z",
            "productId": "698470440b0547d86762f85e"
          },
          "publisherProductId": "coins",
          "quantity": 100,
          "priority": "Sub"
        }
      ],
      "priceInUsdCents": 0,
      "badges": []
    },
    {
      "index": 2,
      "products": [
        {
          "product": {
            "publisherProductId": "coins",
            "name": "Coins",
            "description": "Coins reward.",
            "textFontColorHex": "#FFFFFF",
            "type": "Quantity",
            "prefix": "",
            "suffix": "",
            "images": [
              {
                "type": "product",
                "url": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1762940780865__0f4b7e05-6051-46c8-9160-d155e9ca2c3b"
              },
              {
                "type": "productPrefix",
                "url": ""
              }
            ],
            "displayName": "Coins",
            "createdAt": "2025-11-12T09:46:28.925Z",
            "updatedAt": "2025-11-12T09:46:28.925Z",
            "productId": "69145774cceb99de11dfe64a"
          },
          "publisherProductId": "coins",
          "quantity": 150,
          "priority": "Sub"
        }
      ],
      "priceInUsdCents": 0,
      "badges": []
    },
    {
      "index": 3,
      "products": [
        {
          "product": {
            "publisherProductId": "coins",
            "name": "Coins",
            "description": "Coins reward.",
            "textFontColorHex": "#FFFFFF",
            "type": "Quantity",
            "prefix": "",
            "suffix": "",
            "images": [
              {
                "type": "product",
                "url": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1762940945510__6d0b0fbd-1833-4f01-b230-421a5f4bdba9"
              },
              {
                "type": "productPrefix",
                "url": ""
              }
            ],
            "displayName": "Coins",
            "createdAt": "2025-11-12T09:49:10.063Z",
            "updatedAt": "2025-11-12T09:49:10.063Z",
            "productId": "69145816cceb99de11dfe692"
          },
          "publisherProductId": "coins",
          "quantity": 200,
          "priority": "Sub"
        }
      ],
      "priceInUsdCents": 0,
      "badges": []
    },
    {
      "index": 4,
      "products": [
        {
          "product": {
            "publisherProductId": "coins",
            "name": "Coins",
            "description": "Coins reward.",
            "textFontColorHex": "#FFFFFF",
            "type": "Quantity",
            "prefix": "",
            "suffix": "",
            "images": [
              {
                "type": "product",
                "url": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1763013669345__fda4f44a-19e6-4a9a-b71a-9e55903dfece"
              },
              {
                "type": "productPrefix",
                "url": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1763013758566__745ba5f4-582f-401f-b9fe-08cd218bf778"
              }
            ],
            "createdAt": "2025-11-11T13:42:51.928Z",
            "updatedAt": "2025-11-13T06:02:42.481Z",
            "displayName": "Coins",
            "productId": "69133d5bcceb99de11df0200"
          },
          "publisherProductId": "coins",
          "quantity": 250,
          "priority": "Sub"
        }
      ],
      "priceInUsdCents": 0,
      "badges": []
    },
    {
      "index": 5,
      "products": [
        {
          "product": {
            "publisherProductId": "coins",
            "name": "Coins",
            "description": "Coins reward.",
            "textFontColorHex": "#FFFFFF",
            "type": "Quantity",
            "prefix": "",
            "suffix": "",
            "images": [
              {
                "type": "product",
                "url": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1770287224409__a406068e-4153-4f75-93b9-ea884d6fac82"
              },
              {
                "type": "productPrefix",
                "url": ""
              }
            ],
            "displayName": "Coins",
            "createdAt": "2026-02-05T10:27:18.553Z",
            "updatedAt": "2026-02-05T10:27:18.553Z",
            "productId": "6984708615abbcb66f201dbe"
          },
          "publisherProductId": "coins",
          "quantity": 300,
          "priority": "Sub"
        }
      ],
      "priceInUsdCents": 0,
      "badges": []
    },
    {
      "index": 6,
      "products": [
        {
          "product": {
            "publisherProductId": "coins",
            "name": "Coins",
            "description": "Coins reward.",
            "textFontColorHex": "#FFFFFF",
            "type": "Quantity",
            "prefix": "",
            "suffix": "",
            "images": [
              {
                "type": "product",
                "url": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1770287198121__4f7c17dc-7a12-4554-89b2-dd90c51e8114"
              },
              {
                "type": "productPrefix",
                "url": ""
              }
            ],
            "displayName": "Coins",
            "createdAt": "2026-02-05T10:26:41.716Z",
            "updatedAt": "2026-02-05T10:26:41.716Z",
            "productId": "6984706115abbcb66f201dae"
          },
          "publisherProductId": "coins",
          "quantity": 350,
          "priority": "Sub"
        }
      ],
      "priceInUsdCents": 0,
      "badges": []
    },
    {
      "index": 7,
      "products": [
        {
          "product": {
            "publisherProductId": "chest",
            "name": "Chest",
            "description": "Chest reward.",
            "textFontColorHex": "#FFFFFF",
            "type": "Quantity",
            "prefix": "",
            "suffix": "",
            "images": [
              {
                "type": "product",
                "url": "https://media-staging.appcharge.com/media/69133d595af23405d88843a5/1770287158114__a4266bfc-297f-47c9-b5e5-16d7fdb987ea"
              },
              {
                "type": "productPrefix",
                "url": ""
              }
            ],
            "displayName": "Chest",
            "createdAt": "2026-02-05T10:26:12.307Z",
            "updatedAt": "2026-02-05T10:26:12.307Z",
            "productId": "698470440b0547d86762f85e"
          },
          "publisherProductId": "chest",
          "quantity": 1,
          "priority": "Main"
        }
      ],
      "priceInUsdCents": 0,
      "badges": []
    }
  ],
  "priority": 1,
  "startOver": false,
  "rewardCalendar": {
    "resetBehavior": "ToCalendarStart",
    "popupTrigger": "ShowAutomatically",
    "rewardCollectionBehavior": "ForcePlayerToCollect"
  },
  "badges": [],
  "createdAt": "2026-06-11T05:09:03.575Z",
  "updatedAt": "2026-06-11T05:09:03.575Z",
  "offerId": "6a2a42ef85ce5ccba45444f3"
}

Headers

​
x-publisher-token
string
required

Publisher token used for authentication.

Body

application/json
​
publisherOfferId
string
required

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

Example:

"reward-calendar-1"

​
name
string
required

Reward Calendar offer name.

Example:

"Weekly Reward Calendar"

​
type
enum<string>
required

Offer type. For Reward Calendars, use PopUp.

Available options:
PopUp
Example:

"PopUp"

​
subType
enum<string>
required

Popup offer subtype. For Reward Calendars, use RewardCalendar.

Available options:
RewardCalendar
Example:

"RewardCalendar"

​
active
boolean
required

Whether the Reward Calendar offer is active.

Example:

true

​
priority
integer
required

Display priority for eligible popup offers. Lower numbers appear first.

Required range: x >= 1
Example:

1

​
rewardCalendar
object
required

Information about the Reward Calendar behavior configuration.

​
productsSequence
object[]
required

A list of reward tiles. The array length must be a multiple of seven, with one to 10 configured weeks.

Required array length: 7 - 70 elements
​
offerUiId
string

Internal ID of the Reward Calendar offer design. Required if offerExternalUiId is not provided.

Example:

"69fb22e6dd352b799c65e97e"

​
offerExternalUiId
string

External ID of the Reward Calendar offer design. Required if offerUiId is not provided.

Example:

"reward-calendar-design-1"

​
startOver
boolean
default:true

Whether the Reward Calendar restarts from Week 1 after the player completes all configured weeks.

Example:

false

​
segments
string[]

A list of segments eligible for this offer.

Example:
["New User"]

Response

Reward Calendar offer created successfully.

​
publisherId
string

Internal publisher ID.

Example:

"69133d595af23405d88843a5"

​
publisherOfferId
string

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

Example:

"reward-calendar-1"

​
name
string

Reward Calendar offer name.

Example:

"Weekly Reward Calendar"

​
displayName
string

Reward Calendar offer display name.

Example:

"Weekly Reward Calendar"

​
type
enum<string>

Offer type. For Reward Calendars, use PopUp.

Available options:
PopUp
Example:

"PopUp"

​
subType
enum<string>

Popup offer subtype. For Reward Calendars, use RewardCalendar.

Available options:
RewardCalendar
Example:

"RewardCalendar"

​
active
boolean

Whether the Reward Calendar offer is active.

Example:

true

​
priority
integer

Display priority for eligible popup offers. Lower numbers appear first.

Required range: x >= 1
Example:

1

​
startOver
boolean

Whether the Reward Calendar restarts from Week 1 after the player completes all configured weeks.

Example:

true

​
rewardCalendar
object

Information about the Reward Calendar behavior configuration.

​
offerUi
object

Reward Calendar offer design details returned with the offer.

​
productsSequence
object[]

A list of reward tiles. The array length must be a multiple of seven, with one to 10 configured weeks.

Required array length: 7 - 70 elements
​
segments
string[]

A list of segments eligible for this offer.

Example:
["New User"]
​
badges
object[]

Badges attached to the offer.

​
offerId
string

Internal offer ID.

Example:

"69fb22e6dd352b799c65e97f"

​
createdAt
string<date-time>

Date the Reward Calendar offer was created.

Example:

"2026-06-11T05:09:03.575Z"

​
updatedAt
string<date-time>

Date the Reward Calendar offer was updated.

Example:

"2026-06-11T05:09:03.575Z"