updateReward( )

Updates a loyalty reward.

Use this endpoint to update details of a reward, such as the name, whether or not a reward is active, or the amount of points it costs to redeem. Also use this endpoint to add new tiers that are eligible to redeem a reward.

You may not change the type of a reward. That is set upon creation and cannot be updated.

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
Learn more about app permissions.
Method Declaration
Copy
function updateReward(
  _id: string,
  reward: UpdateReward,
): Promise<UpdateRewardResponse>;
Method Parameters
_idstringRequired

Reward ID.

rewardUpdateRewardRequired

Reward info to update.

Returns
Return Type:Promise<UpdateRewardResponse>
JavaScript
import { rewards } from "@wix/loyalty";

async function updateReward(id, reward) {
  const response = await rewards.updateReward(id, reward);
}
Errors

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

Did this help?