June 2022 Release

Production Release Dates: June 15 and July 6

Mission Builder Enablement

Our new mission builder has completed its beta cycle and is live in Production. In our August 2022 release (tentatively planned for August 31), the mission builder will be enabled as the default method of creating new missions. See Create a Mission for detailed steps on using the new mission builder.

REST APIs

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

• Removed the "Admin Only" section and moved the admin APIs to other sections.

• /exchanges, /exchanges/{exchangeId}, /users/{userId}/exchanges, and /users/{userId}/exchanges/{exchangeId} - Added the useGiverBillCodes parameter to determine if the giver or receiver’s bill codes are used.

• /users/{userId}/actions - Modified for better troubleshooting of action events.

  • actionTime - Returns the time the action occurred.

  • createTime - Returns the time the action was logged in Nitro. If the action is not backdated, the actionTime and createTime should be the same or seconds apart.

  • eventId - Allows you to specify and return a custom value that's unique within your site. If an eventId is not set, a generic ID is created.

• POST and GET /challenges/{challengeId}/rewards and GET, PUT, and DELETE /challenges/{challengeId}/rewards/{rewardId} - Modified for an upcoming feature.

  • isDefault and linkedToAwardAccount - Now nested under pointCategory.

  • limit - New nested object where the amount and days parameters determine if the award is limited by a number of points or days.

  • amountSpent - Optional parameter used to display the number of days or points that have been awarded.

  • outOfStock - Used to determine if the reward has reached its defined limit.

• GET /users/{userId}/points and GET and PUT /users/{userId}/points/{pointsId} - These methods are deprecated, but still supported. These methods set a point balance rather than doing a debit/credit. Use /users/{userId}/point-balance instead.

• GET and PUT /users/{userId}/point-balance - New methods.

  • lifetimeBalance - The lifetime balance should always be equal to creditBalance plus debitBalance.

  • creditBalance - The amount you want to add as a credit.

  • debitBalance - The amount to debit. debitBalance cannot be used with an award account point category.

  • syncLifetimeBalance - If true, the lifetimeBalance will be set to the same value as the creditBalance, and the debitBalance will be set to 0. If false, the lifetimeBalance will be adjusted by the same amount as the creditBalance and the debitBalance will not change.

• GET and POST /users/{userId}/actions - Added the eventId parameter which can be used to send a unique customer value with the action.

Product Enhancements

Bill Codes

Our Bill Codes feature is now available for all award account programs. Bill codes allow you to charge point earning activity to different entities such as a group, country code, or custom value. In this release, we added the ability to choose if points earned from a recognition should be billed to the giver or receiver of the recognition.

Contact Bunchball Support to enable bill codes in your program.

Event ID

This release includes an update to our actions APIs that allows you to send a unique custom value in the eventId parameter. This value is returned in the response and can be used to add information about the action event. If an eventId is not specified, Nitro will create one for you.

The actionTime, createTime, and eventId are shown in Nitro Studio on the User Management view Actions tab.

Product Fixes

• Fixed an issue where Nitro Studio administrators couldn't reset their own passwords.

• Fixed an issue in transactional points reports where duplicate entries were showing for point categories.

• Fixed an issue where an admin was able to manually award a non-repeatable mission to a user more than once in Nitro Studio.

• Changed the refresh rate on the mission builder's Availability tab to update the Total Completions Limits information faster.

• Updated the description for the Update Lifetime Balance option to reference the documentation site.

• Fixed an alignment issue and a validation issue on the Award Account Bill Codes tab.

*** Discontinuation Notice ***

Bunchball will deprecate and remove the Performance web component from the platform next month. The GET /users/{userId}/challenges/{challengeId}/actions and /users/{userId}/challenges/{challengeId}/metrics APIs used by the Performance web component will also be deprecated.

See also

Release Notes