adjustPoints( )


Adjusts the point balance of a loyalty account.

The adjustPoints() function returns a Promise that resolves to the updated loyalty account.

To adjust the points balance of an account you must include an accountId, a revision number, and the adjustment to make. You can also leave a description to explain the reason for the points adjustment.

There are two ways to adjust the points of a loyalty account:

  • balance allows you to set the total points balance to this new amount. The transaction type will return as "ADJUST".
  • amount allows you to alter the points balance by this amount. This amount can be a positive number to increase the points balance or a negative number to decrease the balance. The transaction type will return as "GIVE".

An account may not be adjusted to a negative balance. If you pass values in both the balance and the amount parameters then the balance adjustment takes effect and the amount adjustment is ignored.

Note: Only visitors with Manage Loyalty permissions can manually adjust points in a loyalty account.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Loyalty
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
accountIdstringRequired

Loyalty account ID.


optionsAdjustPointsOptions

Options to use when adjusting points.

Returns
Return Type:Promise<AdjustPointsResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?