Point activity

The points activity is used to manually change a user's points. The points activity can be used to perform four different types of actions on a user's points:

• Increment: increments the user's total points and point balance.
• Set: sets the user's total points and updates the point balance.
• Redeem: decrements the user's points balance and increments the user's spent points.
• Refund: decrements the user's spent points and increments the user's point balance.

note

• Negative values can be used with increments to decrease points.
• The redeem and refund actions require the points to be redeemable.
• The ability to set points is disabled for points that expire.

Example

Here's an example of a point activity data that increments a user's points:

JSON

var pointActivity = {
  uuid: "john@doe.com",
  url: "http://www.domain.com",
  reason: "You get these points for being amazing!",
  attrs: {
    type: "point",
    action: "increment",
    points: [
      {
        pointId: "55cbb97a5d7fa839a2cc8f92",
        points: 100,
      },
    ],
  },
};

In this example:

• The user is identified by the email 'john@doe.com'
• The action is 'increment', which will add points to the user's balance
• The reason field provides context for why the points are being awarded
• The points array specifies which point type(s) to modify and by how much

Related topics

---

• Activities overview
• Points
• Rewards
• Leaderboards