Link Creation API

Create short links instantly.

Drop in your destination URL and get a clean, trackable short link. Control redirects, preview behavior, and analytics—all in one request.

Generating links at scale? Use the Bulk Create API or manage them directly in your dashboard (login required).

Every short link includes an auto-generated QR code.

  • Access it at https://vvd.bz/[linkId]/qr and adjust the size using the size parameter.
  • Example: https://vvd.bz/hj7V/qr?size=200 → returns a 200px QR code.
POST

/api/link/v2/create 

{
    "url": "https://www.facebook.com/vivoldi365",
    "domain": "https://vvd.bz"
}

Request Parameters

url string required
Original URL.
Up to 3,000 bytes allowed.
domain string required
Default:https://vvd.bz
Link domain.
If “brandLinkId” is set to Y, the domain will be https://vvd.im.
You can also use a custom domain.
redirectType integer
Default:302
Enum:
200301302
Redirect type.
See Terminology for details.
This feature is available on Personal plans and above.
reuseYn string
Default:N
Enum:
YN
Whether to reuse an existing URL.
Y: If the same long URL already exists, a new short URL is not created — the first generated short URL is returned.
N: A new short URL is always created.

This option is used to prevent duplicate long URLs or to reuse existing links.
This feature is available only in Premium plans and higher.
grpIdx integer
Used to group links.
Group IDX can be found via the Link Group List API or in the dashboard.
brandLinkId string
If not set, the link ID is automatically generated by the system.
Without a custom domain, the default link domain is https://vvd.im.
Example: https://vvd.im/[brandLinkId]
ttl string
Link title. If not specified, the webpage title of the original URL is used.
For faster creation, set this value directly to skip parsing.
description string
When redirectType is 200, the description meta tag can be set.
metaImg string
When redirectType is 200, the image meta tag can be set.
Image URLs must start with https://.
memo string
Notes for link management.
notfSubscYn string
Default:N
Enum:
YN
Push subscription link.
If set to Y, a landing page opens before redirecting, asking the user for push permission.
If denied or canceled, the user is sent directly 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 Y, alerts are sent to devices with the Vivoldi app when the set click count is reached (configured in Dashboard → Settings).
This feature is available on Personal plans and above.
mailNotifyYn string
Default:N
Enum:
YN
Email notifications for clicks.
If Y, email alerts are sent when the set click count is reached (configured 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": "https://vvd.bz/jH3d"
}

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 string
Response value. The shortened link is returned.
Example: https://vvd.bz/jH3d

When to Use This API

Use the Link Creation API in scenarios like these:

  • Turn long URLs into short, shareable links
  • Create trackable links for marketing campaigns
  • Generate multiple links automatically at scale
  • Dynamically create links through external integrations
Short links come with built-in analytics, so you can track performance and make data-driven decisions.

Key Features & Options

Go beyond basic shortening with advanced control.

  • redirectType: Define redirect behavior (301, 302, 307, etc.)
  • reuseYn: Reuse an existing short link for the same URL
  • ttl, description, metaImg: Customize social previews (Open Graph)
  • pushNotifyYn, mailNotifyYn: Get notified on every click
  • webhook: Send events to external systems in real time
Short links include built-in analytics, enabling data-driven performance tracking.

Use Cases

Apply the Link Creation API across a wide range of scenarios.

  • E-commerce: Auto-generate short links for each product
  • Advertising: Create trackable links by channel
  • SaaS platforms: Generate personalized links per user
  • CRM: Trigger links automatically based on customer actions

Important Notes

Review these before making your request.

  • Invalid URLs will cause the request to fail
  • With reuseYn enabled, an existing link may be returned instead of a new one
  • redirectType affects SEO performance and caching behavior
  • Some features may vary depending on your plan
Careful configuration ensures consistent, predictable results.