Dukan icon

Dukan

Interact with the Dukan API

Store Coupon → Update

AI-generated

Summary

Update an existing store coupon by specifying its coupon ID and modifying any desired fields such as coupon code, promotion type, discount value, expiration settings, and usage limits.

Inputs

  • Coupon ID (required) — The unique identifier (MongoDB ObjectId) of the coupon to update.
  • Use JSON — Toggle whether to define the update payload using raw JSON.
  • JSON — JSON string with optional properties: couponCode (string), promoType ('percentage' or 'fixed-price'), value (number), allowExpiration (boolean), couponExipreAt (string, e.g. ISO date), allowLimits (boolean), limit (number). Used only if 'Use JSON' is enabled.
  • Additional Fields — Set coupon fields individually instead of using JSON. Fields include couponCode (max 8 characters), promoType ('percentage' or 'fixed-price'), value (discount amount), allowExpiration (boolean), couponExipreAt (expiration date string), allowLimits (boolean), and limit (usage limit number).
  • Force Custom Auth Header — Optionally override default credentials with a custom API key for this request.
  • Custom API Key — The API key to use when custom authentication is enabled.
  • Force Custom Base URL — Optionally override the default credentials base URL with a custom URL for this request.
  • Custom Base URL — Base URL for API requests when custom base URL is enabled (exclude '/v1/external' suffix).

Output shape

The updated coupon data returned from the API.

The update request sends the provided fields in the request body, either parsed from JSON or from individual fields. The API response includes the updated coupon information. This operation requires the coupon ID as input.

Links

Discussion