February 2024 Release

Production Release Date: February 28

*** Upcoming API Deprecation ***

Effective with the August 2024 release, we will deprecate and remove the following parameter from the platform. Update any code that uses this parameter in advance of the August release.

• GET /users/{userId}/challenges - We will deprecate the value parameter in the rewards section of the response. Update any code that references the value parameter to use the pointAward parameter.

REST APIs

The following API changes are documented on https://api.bunchball.com/docs.

• GET /users/{userId}/challenges - Added the point category shortName and iconUrl parameters to the response for missions with a limited point reward. Updated the LegacyChallengeReward model to define the expiringSoon, outOfStock, and limit parameters.

• GET /users/{userId}/challenges/{challengeId}/progress - Added additional information to the response when a mission is locked for a prerequisite mission and/or level. Updated the ChallengeStatusLocked model to define the reasons array.

The following APIs are experimental and still under active development. We do not recommend using these APIs until they are no longer classified as experimental. Updates made while in the experimental stage may not be backwards compatible.

• GET /users/{userId}/leaderboards/{leaderboardId} – Returns leaderboard data for the leaderboard section in Impact.

• GET /users/{userId}/ranked-challenges - Returns a user's eligible missions using the Nitro ranking system.

Product Enhancements

Theme Builder General Release

Our new theme builder is now in General Release! The theme builder is used to style blocks. Using the theme builder, you can:

• Upload or link to a CSS stylesheet containing your custom styles.

• See how your styles will look in the Recognitions block.

• Set a theme as active to immediately apply the styles to all embedded blocks.

User Preference Security

The firstName, lastName, and additionalName user preferences have been updated to allow the at sign (@) as a valid value. This update was made to support programs where these preferences store a user's email address.

Product Fixes

• Updated the Recognitions block and web component to improve the search speed of the recipient lookup.

• Updated the Recognitions block embed code to remove "remix" from the URL.

Documentation Updates

• Added an example mission configuration for claiming a level bonus using a self-reporting action.

See also

Release Notes