Deprecation

Introduction

As the platform evolves, API endpoints and data model fields may change through removal or replacement. We maintain backwards compatibility for a transition period to allow you to migrate away from changing components.

This guide lists all APIs and data model properties that are being removed or replaced, organized by urgency.

APIs

API End-point	Deprecated since	Removal after	SDK method	Replacement
POST /v1/js/{key}/{site} /leaderboards/behaviour/{id}	7.4.2	1st January 2025	N/A	N/A
POST /v1/{site}/activities	6.3.0	1st June 2024	ActivitiesService .createAsync()	POST /v2/{site}/activities
POST /v1/js/{key}/{site}/activities	6.3.0	1st June 2024	N/A	POST /v2/js/{key}/{site}/activities

Data models

Data model	Property	Deprecated since	Removal after	Replacement
Activity	activity.points	9.0.1	1st January 2026	GET /v1/points/transactions/{activityId}
User	user.facebook	8.0.3	1st July 2025	Facebook properties can be added to users via custom fields.
User	user.twitter	8.0.3	1st July 2025	Twitter properties can be added to users via custom fields.
User	user.points	7.6.0	1st April 2025	The points property associated to the user can now be retrieved by using the user point wallets and transactions endpoints.
AwardedBehaviour, AwardedReward, AwardedKPI	prizes.coupon, prizes.couponId, prizes.hideCoupon	6.2.5	1st April 2023	This property will no longer be populated in request to the Notifications API. The coupon's now have a separate notification with an AwardedCoupon which should be used instead of the field above.

Other deprecations

Item	Deprecated since	Removal after	Notes
OAuth2Exception invalid_token exception	8.0.0	1st January 2026	As of version 8.0.0 all OAuth2Exception errors conform to the OAuth 2 specification. Versions prior to 8.0.0 will continue to receive the old UnauthorizedException for the invalid_token error until the version is upgraded to version 8.0.0 or later.
pointIds query parameter on GET /v1/{site}/activities and GET /v1/{site}/activities/{uuid}	7.6.0	1st April 2025	Filtering activities by points is being replaced by filtering point transactions by pointId. See the user point transactions endpoint.
Java/PHP/.NET SDKs pre 6.3.0	6.3.0	1st June 2024	Java/PHP/.NET SDKs prior to Mambo 6.3.0 used the POST /v1/js/{key}/{site}/activities endpoint, which is now no longer supported. Upgrade to a more recent version of the SDK that uses v2 endpoints.
Widgets and Javascript SDKs pre 6.3.0	6.3.0	1st June 2024	Widgets and Javascript SDKs prior to Mambo 6.3.0 used the POST /v1/js/{key}/{site}/activities endpoint, which is now no longer supported. Upgrade widgets to a more recent version.
JSONP support	6.0.0	1st January 2024	All Javascript APIs support CORS since Mambo 6.0.0. Javascript requests relying on JSONP should be migrated to CORS. If you are using the Mambo Widgets you can simply update them to the latest version.
Widgets pre 5.18.0	6.0.0	1st January 2024	Widgets prior to Mambo 6.0.0 relied on JSONP and will no longer be supported. Upgrade Widgets to a more recent version that uses CORS.

How to prepare for deprecations

1. Identify affected components: Review your integration against the tables above to identify components that need updating.

2. Prioritise by removal date: Focus on items with the nearest removal dates first.

3. Test thoroughly: After making changes, ensure your integration works correctly with the new endpoints or data models.

4. Stay updated: Check this documentation regularly as new deprecations may be added.