Create Link
This is the basic API for creating short links.
To create multiple links at once, use the Bulk Create API or go to the [Bulk Link Creation] menu in the dashboard.
A QR code is automatically generated for every short link.
- QR codes can be accessed at https://vvd.bz/
[linkId]
/qr, and you can adjust the size with the size parameter. - Example: https://vvd.bz/hj7V/qr?size=200 → Returns a QR code at 200px.
POST
/api/link/v2/create
{
"url": "https://www.facebook.com/vivoldi365",
"domain": "https://vvd.bz"
}
Request Parameters
- urlstringrequired
- Original URL.
Up to 3,000 bytes allowed. - domainstringrequired
- Default:https://vvd.bz
- Link domain.
If “brandLinkId” is set toY
, the domain will behttps://vvd.im
.
You can also use a custom domain. - redirectTypeinteger
- Default:302
- Enum:200301302
- Redirect type.
See Terminology for details.This feature is available on Personal plans and above.
- grpIdxinteger
- Used to group links.
Group IDX can be found via the Link Group List API or in the dashboard. - brandLinkIdstring
- If not set, the link ID is automatically generated by the system.
Without a custom domain, the default link domain ishttps://vvd.im
.
Example: https://vvd.im/[brandLinkId] - ttlstring
- Link title. If not specified, the webpage title of the original URL is used.
For faster creation, set this value directly to skip parsing.
- descriptionstring
- When
redirectType
is200
, the description meta tag can be set. - metaImgstring
- When
redirectType
is200
, the image meta tag can be set.
Image URLs must start withhttps://
. - memostring
- Notes for link management.
- notfSubscYnstring
- Default:N
- Enum:YN
- Push subscription link.
If set toY
, 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. - pushNotifyYnstring
- Default:N
- Enum:YN
- Push notifications for clicks.
IfY
, 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.
- mailNotifyYnstring
- Default:N
- Enum:YN
- Email notifications for clicks.
IfY
, email alerts are sent when the set click count is reached (configured in Dashboard → Settings).This feature is available on Personal plans and above.
- delYmdtdatetime
- 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
- codeinteger
- Response code: 0 = Success, other values = Error
- messagestring
- Response message. If the response code is not 0, an error message is returned.
- resultstring
- Response value. The shortened link is returned.
Example: https://vvd.bz/jH3d