Coupon Delete API

The Vivoldi Coupon Delete API lets you permanently delete issued coupons.

Once deleted, the coupon is immediately invalidated and all future redemption attempts are blocked.
To delete multiple coupons in bulk, use the dashboard.

This API is available on the Personal plan or higher.

DELETE

/api/coupon/v1/delete?cpnNo={cpnNo} 


DELETE /api/coupon/v1/delete
        ?cpnNo=ZJLF0399WQBEQZJM

Request Parameters

cpnNostringrequired
Coupon number. 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

code integer
Response code: 0 = Success, other values = Error
message string
Response message. If the response code is not 0, an error message is returned.
result null

When to Use This API

Use this API in the following scenarios:

  • Immediately block incorrectly issued coupons
  • Clean up coupons after a campaign ends
  • Remove duplicate or test coupons
  • Disable coupons that may be subject to misuse

In production environments, it is commonly used for risk control rather than simple cleanup.

Difference Between Deletion and Expiration

There are two ways to prevent a coupon from being used.

Setting endYmd (expiration date) to a past date marks the coupon as expired while keeping the data, allowing it to be reactivated later by extending the date.
In contrast, calling the Delete API permanently removes the coupon data and it cannot be restored.

If you only need to disable a coupon temporarily, adjusting the expiration date via the Update API is recommended instead of deleting it.

Use cases

  • Post-campaign cleanup: Remove coupons that are no longer needed after an event ends to keep your list organized
  • Delete invalid coupons: Immediately remove coupons created by mistake, for testing, or with incorrect settings
  • Block leaked coupons: If a coupon code is exposed, call the Delete API to prevent further use right away

After deletion, the same coupon code can still be reused to create a new coupon if needed.

Things to consider

Deletion is irreversible. Check the following before proceeding:

  • Ensure the coupon is not currently used in an active campaign.
  • If a coupon already issued to users is deleted, an error will occur when they attempt to use it.
  • Associated analytics data may also be removed. Back up click and usage history if needed.