링크 수정 API
생성된 단축 링크의 정보를 수정하는 API입니다.
URL, 리다이렉트 방식, 미리보기 정보, 알림 설정 등 다양한 옵션을 변경할 수 있으며, 기존 linkId는 유지된 상태에서 일부 값만 업데이트됩니다.
링크 유형(URL)인 경우에만 허용되며, 기타 Form 링크·버튼 링크 등은 이 API로 수정할 수 없습니다.
PUT
/api/link/v2/update
{
"linkId": "4Rt3",
"domain": "https://vvd.bz",
"ttl": "new title",
"memo": "new my memo"
}
Request Parameters
- linkId string required
- 링크ID. URL이 “https://vvd.bz/fML”이면 링크ID는 fML 입니다.
- domain string required
- Default:https://vvd.bz
- 링크 도메인.
- redirectType integer
- Default:302
-
Enum:
200301302
-
Redirect 방식.
자세한 내용는 주요 용어 페이지에서 확인하세요.
이 기능은 퍼스널 요금제 이상에서만 제공됩니다. - grpIdx integer
- 링크를 그룹화할 때 사용됩니다. 그룹IDX는 그룹 목록 API를 호출하거나 대시보드에서 확인할 수 있습니다.
- url string
-
원본 URL. 최대 3,000 bytes까지 입력 가능합니다.
이 기능은 프리미엄 요금제 이상에서만 제공됩니다. - ttl string
- 링크 제목.
- description string
-
redirectType값이200일 경우, description 메타 태그를 설정할 수 있습니다. - metaImg string
-
redirectType값이200일 경우, image 메타 태그를 설정할 수 있습니다.
이미지 URL은 반드시https://로 시작해야 합니다. - memo string
- 링크 관리용 메모입니다.
- notfSubscYn string
- Default:N
-
Enum:
YN
-
푸시구독 링크 여부입니다.
값이
Y이면 원본 URL로 이동되기 전에 랜딩 페이지가 열리며, 사용자에게 푸시 알림 권한을 요청합니다.
사용자가 권한을 거부하거나 취소하면 즉시 원본 URL로 이동됩니다. - qrBypassYn string
- Default:N
-
Enum:
YN
-
QR 코드 스캔 시 단축 URL을 거치지 않고, 사용자가 설정한 원본 URL로 직접 이동할지 여부를 제어합니다.
Y: 단축 URL을 거치지 않고 원본 URL로 직접 이동합니다. (QR 스캔 통계 미기록)
N: 단축 URL을 거친 후 원본 URL로 이동합니다. (QR 스캔 통계 기록됨)
- blockOverseasSticsYn string
- Default:N
-
Enum:
YN
- 해외통계 차단 여부입니다. 한국 외 국가에서 접속하면 클릭 수는 집계되지 않습니다.
- pushNotifyYn string
- Default:N
-
Enum:
YN
-
클릭 수 푸시 알림 여부입니다.
값이
Y이면 대시보드의 [설정 -> 환경 설정]에서 지정한 클릭 수에 도달할 때마다 비볼디 앱이 설치된 기기로 알림이 전송됩니다.
이 기능은 퍼스널 요금제 이상에서만 제공됩니다. - mailNotifyYn string
- Default:N
-
Enum:
YN
-
클릭 수 메일 알림 여부입니다.
값이
Y이면 [설정 -> 환경 설정]에서 지정한 클릭 수에 도달할 때마다 이메일로 알림이 전송됩니다.
이 기능은 퍼스널 요금제 이상에서만 제공됩니다. - webhookEnableYn string
- Default:N
-
Enum:
YN
-
Webhook 사용 여부.
전역 Webhook이 활성화되어 있어야 합니다.
이 기능은 엔터프라이즈 요금제에서만 제공됩니다. - webhookMetric string
- Default:C
-
Enum:
CP
- Webhook 수신 기준. C:클릭 수 기준, P:사람 수 기준(고유 클릭 수)
- webhookFrequency integer
- Default:1
-
Enum:
1501002003005001000
- Webhook 수신 주기. 1:매번 클릭 시, 50:50회 마다, 100:100회 마다, 300:300회 마다, 500:500회 마다, 1000:1,000회 마다
- delYmdt datetime
-
링크 삭제 예약 일시입니다.
지정한 날짜가 지나면 링크는 시스템에 의해 자동으로 삭제됩니다.
예: 2025-08-30 23:59:59
{
"code": 0,
"message": "",
"result": null
}
Response Parameters
- code integer
- 응답 코드: 0 = 성공, 그 외 값 = 오류
- message string
- 응답 메시지입니다. 응답 코드가 0이 아니면, 오류 관련 메시지가 반환됩니다.
- result null
언제 이 API를 사용하나요?
다음과 같은 상황에서 링크 수정 API를 사용합니다.
- 기존 단축 링크의 원본 URL을 변경해야 할 때
- 링크의 리다이렉트 방식, 만료 시점, 메모 등 설정을 업데이트할 때
- 이미 배포된 단축 링크를 삭제하지 않고 내용만 교체할 때
- 웹훅, 알림 등 연동 설정을 사후에 변경해야 할 때
링크 생성 API와 차이점
링크 수정 API는 생성 API와 파라미터 구조가 유사하지만 다음과 같은 차이가 있습니다.
linkId와domain은 필수 파라미터이며, 수정할 링크를 정확히 식별해야 합니다.- 일부 파라미터만 선택적으로 변경 가능
- 기존 통계 및 데이터 유지
url변경은 프리미엄 요금제 이상에서만 가능- Form 링크, 버튼 링크 등 URL 유형이 아닌 링크는 수정 불가
활용 예시
링크 수정 API는 다양한 방식으로 활용할 수 있습니다.
- 쇼핑몰: 이미 배포된 상품 링크의 목적지 URL을 재고 상황에 따라 동적으로 변경
- 광고: 동일한 단축 링크로 시즌별 랜딩 페이지를 교체하여 링크 재배포 비용 절감
- 서비스 운영: 장애 발생 시 단축 링크가 가리키는 URL을 즉시 대체 페이지로 전환
- SNS 공유 이미지 및 제목 업데이트
사용 시 주의사항
링크 수정 시 다음 사항을 확인하세요.
- URL 변경 시 기존 사용자 경험이 달라질 수 있습니다
- 잘못된 설정 변경은 서비스 동작에 영향을 줄 수 있습니다
notfSubscYn을Y로 설정하면 URL 변경 전 구독자에게 알림이 발송됩니다. 알림 발송 후 취소는 불가능하므로 신중하게 사용하세요.- 삭제된 링크는 이 API로 복구할 수 없습니다