Developer API

Edit Coupon

This API allows you to update the information of an existing coupon.
However, if the coupon has already been used, only the "memo" field can be edited; all other fields are locked.

This API is available starting from the Personal plan.

Http Header

PUT /api/coupon/v1/update
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: application/json
User-agent: {Your User-agent}
Accept-Language: en

Request

{
	"cpnNo": "",  // You can specify a coupon code manually. If left empty, a 16-character code will be generated automatically by the system.
	"grpIdx": 271,
	"tmplIdx": 0,
	"nm": "$5 discount coupon",
	"discTypeIdx": 458,
	"disc": 5,
	"strtYmd": "2025-01-01",
	"endYmd": "2025-12-31",
	"onsiteYn": "Y",
	"onsitePwd": "123456",
	"memo": "New Member Registration, IP: 211.111.222.33",
	"url": "https://bestshop.com",
	"useLimit": 1,
	"userId": "att78z",
	"userNm": "Brown Smith",
	"userPhnno": "+1 123-4567-8900",
	"userEml": "",
	"userEtc1": "Gold rating",
	"userEtc2": ""
}

Fields	Field Descriptions	Description	Type
cpnNo	Coupon Code	The coupon code to be updated. Enter the code without the "-" symbol.	string
grpIdx	Coupon Group	Coupon groups are used to categorize coupons. If group settings conflict with coupon settings, the group settings will take precedence. Group IDX can be found on the Coupon Group Page in the dashboard. Default: 0	int
tmplIdx	Coupon Template	Coupon templates provide users with details such as description, usage, and precautions. Template IDX can be found on the Coupon Template Page in the dashboard. Default: 0	int
nm	Coupon Name	The name of the coupon displayed on the coupon page.	string
discTypeIdx	Discount Type	Sets the discount type for the coupon (percentage or fixed amount). 457: Percentage (%), 458: Fixed Amount Use percentage for rate-based discounts. Use amount for fixed value discounts.	int
disc	Discount Value	If discount type is percentage (457), enter a value between 1% and 100%. If discount type is amount (458), enter the discount amount.	double
discCurrency	Currency	Set the currency when using fixed amount discounts (458). KRW, CAD, CNY, EUR, GBP, IDR, JPY, MUR, RUB, SGD, USD Default: KRW	string
strtYmd	Start Date	Set the start date for coupon validity. Date format: yyyy-mm-dd (10 characters) Example: 2024-10-01	date
endYmd	End Date	Set the expiration date for coupon validity. Date format: yyyy-mm-dd (10 characters) Example: 2024-12-31	date
onsiteYn	On-site Coupon	If set to Y, a “Use Coupon” button will appear on the coupon page. The customer shows the coupon to staff, who then process its usage. Ideal for offline stores.	Y or N
onsitePwd	On-site Coupon Password	If a password is set, staff must enter it to mark the coupon as used. Prevents users from using the coupon on their own.	string
memo	Memo	Used for internal management purposes. Not visible to users.	string
url	URL	If a URL is entered, a “Go to Use Coupon” button appears on the coupon page, linking to the URL. If an image is uploaded, clicking it will also redirect to the URL.	string
useLimit	Usage Limit per Person	Sets how many times a person can use the coupon. Values from 2 to 5 require the use of Vivoldi’s REST API and user ID must be provided. When managing usage manually in the dashboard, only “Unlimited” or “1 Time” can be selected. 0: Unlimited, 1: 1 Time, 2: 2 Times, 3: 3 Times, 4: 4 Times, 5: 5 Times	int
color	Text Color	Sets the text color for the coupon on the page. Must be a HEX value, up to 9 characters including transparency. Default: #4F4F4FFF	string
background	Background Color	Sets the background color for the coupon on the page. Must be a HEX value, up to 9 characters including transparency. Default: #FFFFFFFF	string
userId	User ID	Used to track who received and used the coupon. Required when useLimit is 2 to 5. Typically, this is the user’s login ID on your website.	string
userNm	User Name	If you already know who will use the coupon, enter their name here. Useful for managing issuance and usage.	string
userPhnno	User Phone	Enter the phone number of the user who will use the coupon.	string
userEml	User Email	Enter the email of the user who will use the coupon.	string
userEtc1	Additional Info 1	Used to store additional internal information about the user.	string
userEtc2	Additional Info 2	Used to store additional internal information about the user.	string

Response

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

Fields	Description	Type
code	Response code (0:Success)	int
message	The response message, or a related message if the response code is non-zero.	string