Edit Coupon

API to update generated coupon information.

For coupons already used, only the memo field can be updated; other details cannot be changed.

This API is available for Personal plans and above.

PUT

/api/coupon/v1/update

Request
Response

{
    "cpnNo": "ZJLF0399WQBEQZJM",
    "nm": "$10 discount coupon",
    "disc": 10,
    "endYmd": "2025-12-31"
}

Request Parameters

cpnNostringrequired: Coupon number.
nmstring: Coupon name.
discTypeIdxinteger: Discount type. (457: Percentage %, 458: Fixed amount)
discdouble: For percentage (457): range 1–100%. For fixed amount (458): enter amount.
discCurrencystring: Currency unit. Required when using fixed amount discount (discTypeIdx:458).
strtYmddate: Coupon start date. Example: 2024-10-01
endYmddate: Coupon expiration date. Example: 2024-12-31
The expiration date can only be set until December 31 of the following year.
useLimitinteger: Coupon usage limit. (0: Unlimited, 1–5: Limited number of uses)
If set to 2 or more, userId must be specified.
grpIdxinteger: Coupon group. Used to manage coupons in groups. Group IDX can be checked in the dashboard.
If both group and coupon settings are applied, group settings take priority.
tmplIdxinteger: Coupon template. Template IDX can be checked in the dashboard when creating coupons.
onsiteYnstring: On-site coupon indicator. Shows a “Use Coupon” button on the coupon page.
Required for offline store staff to process coupon usage.
onsitePwdstring: On-site coupon password. Required when redeeming the coupon.
memostring: Internal notes for reference.
urlstring: If a URL is entered, a “Go to Use Coupon” button will appear on the coupon page.
Clicking the button or image redirects to the specified URL.
colorstring: Coupon text color. Enter HEX value. Example: #4F4F4F
backgroundstring: Coupon background color. Enter HEX value. Example: #FFFFFF
userIdstring: Used to manage coupon recipients.
Required if usage limit is set to 2–5. Typically the website login ID or user name.
userNmstring: Coupon user name. For internal management.
userPhnnostring: Coupon user contact number. For internal management.
userEmlstring: Coupon user email. For internal management.
userEtc1string: Additional internal management field.
userEtc2string: Additional internal management field.

{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

codeinteger: Response code: 0 = Success, other values = Error
messagestring: Response message. If the response code is not 0, an error message is returned.
resultnull