Edit Link
This API is used to update the information of a previously created short URL.
Edits are allowed only when the link type is URL.
For other types (such as Post Links, Form Links, Button Links, or Card Links), update requests will be ignored and changes will not be applied.
Http Header
PUT /api/link/v2/update
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: application/json
User-agent: {Your User-agent}
Accept-Language: en
Request
{
"linkId": "4Rt3",
"domain": "https://vvd.bz",
"ttl": "new title",
"memo": "new my memo"
}
Fields | Field Descriptions | Description | Required | Type |
---|---|---|---|---|
linkId | Link ID | ID of the generated short link Example: If the address of the short link is "https://vvd.bz/fML", the link ID is fML. | string | |
domain | Domain | The domain of the short link address. Example: If the address of the short link is "https://vvd.bz/fML", the domain is https://vvd.bz. Important: The value https:// or http:// must be entered. If you set it to a domain other than the domain of the generated short link, an error occurs. | 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 | Change the group of the generated link. To find out the group ID, you need to call the "Group list" API. | int | |
url | Long URL | Change a long URL. You can change long URLs starting with the Premium plan. | string | |
ttl | Link title | If the value is empty, the link title is not modified. | 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 for administration without exposing it to users. If the value is empty, the note will not be modified. | string | |
notfSubscYn | Push Link | If the value is Y, clicking on the generated link will display a web push notification pop-up before being taken to the long link, and if the user has opted in to push notifications, you can send a push message to all users you have allowed. If they disagree or cancel the notification pop-up, they are immediately taken to the original long URL. If you don’t enter a value, then the default value is N. To learn more about push subscription links, click here. | 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 |
Response
{
"code": 0,
"message": "",
"result": null
}
Fields | Description | Type |
---|---|---|
code | Response code (0:Success) | int |
message | The response message, or a related message if the response code is non-zero. | string |