deleteLoyaltyCoupon( )

Deletes a loyalty coupon.

The deletion of a loyalty coupon does not impact the functionality of the corresponding coupon itself.

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 deleteLoyaltyCoupon(_id: string, revision: string): Promise<void>;
Method Parameters
_idstringRequired

ID of the loyalty coupon to delete.

revisionstringRequired

Revision number, which increments by 1 each time the loyalty coupon is updated.

To prevent conflicting changes, the current revision must be passed when updating the loyalty coupon.

JavaScript
import { coupons } from "@wix/loyalty";

async function deleteLoyaltyCoupon(id, revision) {
  const response = await coupons.deleteLoyaltyCoupon(id, revision);
}
Errors

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

Did this help?