쿠폰 수정

생성된 쿠폰 정보를 수정하는 API입니다.

이미 사용된 쿠폰은 메모 항목만 수정할 수 있으며, 다른 정보는 변경할 수 없습니다.

이 API는 퍼스널 요금제 이상에서만 제공됩니다.

PUT

/api/coupon/v1/update

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

Request Parameters

cpnNo string required
쿠폰 번호.
domain string
쿠폰 도메인.
프리미엄 요금제 이상에서는, 커스텀 도메인을 지정할 수 있습니다.
webhookEnableYn string
Enum:
YN
Webhook 사용 여부. 전역 Webhook이 활성화되어 있어야 합니다.
이 기능은 엔터프라이즈 요금제에서만 제공됩니다.
nm string
쿠폰 이름.
discTypeIdx integer
Default:457
Enum:
457458
할인 유형. (457:요율 할인 %, 458:금액 할인)
disc double
Default:0
할인율(457)은 1~100% 범위, 할인금액(458)은 금액 입력
discCurrency string
Default:KRW
Enum:
KRWCADCNYEURGBPIDRJPYMURRUBSGDUSD
화폐 단위. 금액 할인(discTypeIdx:458) 사용시 필수.
strtYmd date
쿠폰 유효 시작일. 예: 2024-10-01
endYmd date
쿠폰 유효 만료일. 예: 2024-12-31
만료일은 다음 해 12월 31일까지만 설정할 수 있습니다.
useLimit integer
Default:1
Enum:
012345
쿠폰 사용 가능 횟수. (0:무제한, 1~5: 횟수 제한)
2회 이상 지정시 userId 값은 반드시 지정해야 합니다.
grpIdx integer
Default:0
쿠폰 그룹. 쿠폰을 그룹으로 관리할 때 사용. 그룹IDX는 대시보드의 쿠폰 그룹 관리에서 확인 가능.
그룹 설정과 쿠폰 설정이 중복될 경우 그룹 설정이 우선순위를 갖습니다.
tmplIdx integer
Default:0
쿠폰 템플릿. 쿠폰 생성 시 참조할 템플릿. 템플릿IDX는 대시보드의 쿠폰 템플릿 관리에서 확인 가능.
onsiteYn string
Default:N
Enum:
YN
현장쿠폰 여부. 쿠폰 페이지에 “쿠폰 사용” 버튼 표시 여부.
오프라인 매장에서 직원이 쿠폰 사용 시 필요.
onsitePwd string
현장쿠폰 비밀번호. 쿠폰 사용 시 필요한 비밀번호.
memo string
내부 참고용 메모.
url string
URL 입력 시 쿠폰 페이지에 “쿠폰 사용하러 가기” 버튼이 표시됩니다.
버튼 또는 쿠폰 이미지 클릭 시 해당 URL로 리디렉션.
color string
쿠폰 글자 색상. HEX 값 입력. 예: #4F4F4F
background string
쿠폰 배경 색상. HEX 값 입력. 예: #FFFFFF
userId string
쿠폰 발급 대상자를 관리하는 데 사용됩니다.
쿠폰 사용 가능 횟수가 2~5로 설정된 경우 반드시 입력해야 하며, 일반적으로 웹사이트 회원의 로그인 ID 또는 영문 이름을 입력합니다.
userNm string
쿠폰 사용자 이름. 내부 관리용.
userPhnno string
쿠폰 사용자 연락처. 내부 관리용.
userEml string
쿠폰 사용자 이메일. 내부 관리용.
userEtc1 string
추가 내부 관리용 필드.
userEtc2 string
추가 내부 관리용 필드.
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

code integer
응답 코드: 0 = 성공, 그 외 값 = 오류
message string
응답 메시지입니다. 응답 코드가 0이 아니면, 오류 관련 메시지가 반환됩니다.
result null