Edit Link
API to update the information of a generated short URL.
Allowed only when the link type is URL.
Other types (Post Link, Form Link, Button Link, etc.) will not be updated even if the API is called.
PUT
/api/link/v2/update
{
"linkId": "4Rt3",
"domain": "https://vvd.bz",
"ttl": "new title",
"memo": "new my memo"
}
Request Parameters
- linkId string required
-
Link ID.
If the URL is “https://vvd.bz/fML”, the link ID is fML. - domain string required
- Default:https://vvd.bz
- Link domain.
- redirectType integer
- Default:302
-
Enum:
200301302
-
Redirect type.
See Terminology for details.
This feature is available on Personal plans and above. - grpIdx integer
-
Used to group links.
Group IDX can be retrieved with the Link Group List API or from the dashboard. - url string
-
Original URL. Up to 3,000 bytes are allowed.
This feature is available on Premium plans and above. - ttl string
- Link title.
- description string
-
When
redirectTypeis200, the description meta tag can be set. - metaImg string
-
When
redirectTypeis200, the image meta tag can be set.
The image URL must start withhttps://. - memo string
- Notes for link management.
- notfSubscYn string
- Default:N
-
Enum:
YN
-
Push subscription link.
If set toY, a landing page opens before redirecting to the original URL and asks for push notification permission.
If the user denies or cancels, they are redirected immediately to the original URL. - qrBypassYn string
- Default:N
-
Enum:
YN
-
Controls whether to skip the short URL when scanning a QR code and directly access the original URL specified by the user.
Y: Redirects directly to the original URL without passing through the short URL. (QR scan statistics not recorded)
N: Passes through the short URL before redirecting to the original URL. (QR scan statistics recorded)
- pushNotifyYn string
- Default:N
-
Enum:
YN
-
Push notifications for clicks.
If set toY, notifications are sent to devices with the Vivoldi app whenever the configured click count is reached (set in Dashboard → Settings).
This feature is available on Personal plans and above. - mailNotifyYn string
- Default:N
-
Enum:
YN
-
Email notifications for clicks.
If set toY, email alerts are sent whenever the configured click count is reached (set in Dashboard → Settings).
This feature is available on Personal plans and above. - webhookEnableYn string
- Default:N
-
Enum:
YN
-
Whether to enable Webhook.
Global Webhook must be enabled.
This feature is available only in the Enterprise plan. - webhookMetric string
- Default:C
-
Enum:
CP
-
Webhook receiving metric.
C: Based on click count, P: Based on unique users (unique clicks). - webhookFrequency integer
- Default:1
-
Enum:
1501002003005001000
-
Webhook receiving frequency.
1: Every click, 50: Every 50 clicks, 100: Every 100 clicks, 300: Every 300 clicks, 500: Every 500 clicks, 1000: Every 1,000 clicks. - delYmdt datetime
-
Scheduled link deletion date.
After this date, the link is automatically deleted.
Example: 2025-08-30 23:59:59
{
"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