Bulk Link Creation

Request Parameters

linksarrayrequired

An array containing multiple links. Each item has the same structure as the Create API.

urlstringrequired

Original URL.
Up to 3,000 bytes allowed.

domainstringrequired

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.

redirectTypeinteger

Default:302

Enum:

200301302

Redirect type.
See Terminology for details.
This feature is available on Personal plans and above.

reuseYnstring

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.

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 is https://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 is 200, the description meta tag can be set.

metaImgstring

When redirectType is 200, the image meta tag can be set.
Image URLs must start with https://.

memostring

Notes for link management.

notfSubscYnstring

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.

qrBypassYnstring

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)

pushNotifyYnstring

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.

mailNotifyYnstring

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.

webhookEnableYnstring

Default:N

Enum:

YN

Whether to enable Webhook.
Global Webhook must be enabled.
This feature is available only in the Enterprise plan.

webhookMetricstring

Default:C

Enum:

CP

Webhook receiving metric.
C: Based on click count, P: Based on unique users (unique clicks).

webhookFrequencyinteger

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.

delYmdtdatetime

Scheduled link deletion date.
After this date, the link is automatically deleted.
Example: 2025-08-30 23:59:59