Adjust a User's Points Balance

Learn how to manually adjust a user’s points balance in the Loyalty Console or via API.

This article explains how to manually adjust a user's points balance on an ad-hoc basis. To find out more about how user's earn and spend points as part of your program rules, see Earning & burning points in the Loyalty Engine.

Using the Loyalty Console

Adjusting a user's points balance

To manually adjust a user's points balance using the Loyalty Console:

  1. Navigate to the user's profile in the Loyalty Console and select the Wallet tab

  2. Press Adjust Points

  3. Enter a points value, as a positive or negative (i.e. enter 20 to award 20 points or -20 to deduct 20 points)

  4. Optionally, add a comment to explain why the adjustment is being made.

  5. Press Save

  6. The user's points balance will be adjusted and a POINTS_ADJUSTED event will be recorded in their event stream with the comment stored in the payload


Using the API

Since the POINTS_ADJUSTED event type used by the “Adjust Points” function in the Loyalty Console is an intrinsic event type, you cannot directly report it to the Loyalty Engine to adjust a user’s points balance via API.

Instead, manual points adjustments through the API require the creation of a custom event type.

To manually adjust a user’s points balance via the API:

  1. Create a custom event type: Define an event type such as MANUAL_ADJUSTMENT, and include a payload schema with a property called points.

  2. Set up a reactor: Create a reactor triggered by the MANUAL_ADJUSTMENT event, and configure it with an Adjust Points reaction. This reaction should adjust the user’s points balance by the value of the points property multiplied by 1.

  3. Report the event: Use the API to report the MANUAL_ADJUSTMENT event against the user whose balance you want to adjust, specifying the number of points to adjust in the points property of the event payload.


Considerations

  • Adding points: A positive adjustment will be treated as points earned, affecting both the current balance and lifetime earn.

  • Deducting points: A negative adjustment will be treated as points spent, affecting only the current balance. Lifetime earn is never reduced.

  • Irreversible changes: Points adjustments cannot be reversed or cancelled once saved. If you need to undo a change, make another adjustment for the opposite amount.

  • Event stream: Every points adjustment will generate an event in the user’s event stream, which will be visible to the user if your loyalty program end-user interface has an activity log.

  • Points liability impact: See Manual points adjustments and caps.

Last updated

Was this helpful?