Skip to main content

Version changelog

The Version Changelog lists the changes to the APIs that are considered breaking changes. These changes require new versions and are listed below.

You can view your pinned version on the API version page.

Changelog​

8.9.0​

2026-03-13

  • PointTransaction: the points and redeemablePoints properties have been consolidated into a nested points object with total and redeemable properties. A new redeemed property has also been added to the points object.

8.1.0​

2025-06-02

  • Reward: the field unlockConditions has been moved out of the attributes and into the reward object. This means that the achievement attributes behaviours property, the level attributes points property and the mission attributes rewardIds properties have all been aligned and relocated to the reward unlockConditions property.
  • Reward: the progress property has been moved out of the attributes into the reward object. The properties criteriaProgress and criteriaId were renamed to conditionProgress and targetId respectively, to align with the new unlock conditions nomenclature.

7.6.0​

2024-12-13

  • Webhook: renamed the ActivityExpiredPointsDebited event to PointWalletDebitExpired.
  • Webhook Delivery: renamed the ActivityExpiredPointsDebited event to PointWalletDebitExpired.

7.0.0​

2024-03-25

  • Leaderboard: the withRanking property has been replaced by the rankBy property. The rankBy property provides more control over which time periods should having ranking applied to them. If you wish to disable ranking, simply leave the rankBy property empty or null.
  • PrizeDTO: when there is no prize, a null property is returned instead of an empty prize object.

6.3.0​

2023-12-12

  • Behaviour and Reward: renamed the tagFilter property to awardOnlyIfPersonalizationTagsMatch.

6.1.0​

2023-07-27

  • CouponState: renamed the awardedDetails property to stateDetails.
  • CouponStates: renamed the awardedDetails property to stateDetails in the unlocked property.

Complete changelog​

To see a complete changelog that includes both breaking and non-breaking changes, visit our Changelog documentation page.