| url | Long URLs | The long URL that will be redirected when the generated short link is clicked.
It can be up to 3,000 bytes. | | string |
| domain | Domain | If the value is empty, it will be automatically set to the vvd.bz domain.
You must set the value including “https://”, and if the “brandLinkId” option is “Y”, set the domain to “https://vvd.im”.
If you have linked your domain to Vivoldi, you can set the domain.
Example: https://vvd.bz | | string |
| redirectType | Redirect type | Sets how you navigate from a Short URL to a Long URL.
You can choose one of 200, 301, or 302 as the status response code in HTTP. Default value: 302
For more information on redirect methods, see the “Glossary” page. | | int |
| grpIdx | Group ID | Setting a group ID will create a link to that group.
To check the GroupID, you need to call the "Group List" API to get it. | | int |
| brandLinkId | Brand Link ID | If you specify a value, a link will be created with that ID.
(If a branded link is set, the domain will be vvd.im, not vvd.bz)
If the value is empty, the linkID is generated automatically. | | string |
| ttl | Link Title | If the value is empty, it is stored as the webpage title of the long URL.
If the value is empty, the long URL is accessed and HTML parsing is performed, so if the response speed is slow after calling the API, set the title. | | string |
| description | Meta description | You can set the page’s meta tag, description, when “redirectType” has a value of “200”.
This value is ignored when “redirectType” has a value of “301”, “302”, etc. | | string |
| metaImg | Meta image | You can only set the meta image tag when the value of redirectType is “200”.
The meta image value must be in URL format starting with “https://”.
If redirectType is “301” or “302”, the value is ignored. | | string |
| memo | Notes | You can set additional information that you need for administration without exposing it to users. | | string |
| notfSubscYn | Push Link | If the value is Y, when the generated link is clicked, a web push notification pop-up will be displayed before being taken to the long link, and a push message can be sent to all users who have allowed it, if the user has given permission for push notifications.
If they disagree or cancel the notification pop-up, they are immediately taken to the original long URL.
If no value is entered, the default value is N.
To learn more about push subscription links, take a look at the Web Push feature introduction page. | | Y or N |
| pushNotifyYn | Push notifications | If the value is Y, you can receive clicks push notifications to mobile devices with the Vivoldi app installed whenever a link reaches the number of clicks set in the link settings on the "Settings -> Preferences" page.
This feature is available starting with the Personal plan. | | Y or N |
| mailNotifyYn | Mail notifications | If the value is Y, you can receive click count information to your Vivoldi subscribed email whenever you reach the number of link clicks set in the link settings on the "Settings -> Preferences" page.
This feature is available starting with the Personal plan. | | Y or N |
| delYmd | Link removal date | After the set date, the link is automatically deleted by the system.
Deletion cycle: every hour
Example: 2025-12-31 | | Date |