updateCoupon( )

Updates a coupon.

The updateCoupon() function returns a Promise that resolves when the coupon is updated.

Only the properties passed in the specification object will be updated. All other properties will remain the same.

To remove a value from the coupon, pass its corresponding property with a value of null.

When updating a coupon, you cannot change the coupon's type. For example, if the coupon's type is moneyOffAmount, you cannot change it to fixedPriceAmount. You can update the coupon type's value. For example, you can change the value of moneyOffAmount from 5 to 10.

The coupon scope defines the items a coupon applies to. A coupon can apply to all items in a specific Wix application, a group within the application, or a single item within a group. See the introduction for a table of currently supported coupon scopes.

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 Coupons
Manage Stores - all permissions
Learn more about app permissions.
Method Declaration
Copy
function updateCoupon(_id: string, specification: Specification): Promise<void>;
Method Parameters
_idstringRequired

ID of the coupon to update.

specificationSpecificationRequired

Coupon information to update.

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

async function updateCoupon(id, specification, fieldMask) {
  const response = await coupons.updateCoupon(id, specification, fieldMask);
}
Errors

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

Did this help?