リンクの編集

生成された短縮URL情報を更新するAPIです。

リンクタイプがURLの場合のみ有効です。 他のタイプ（投稿リンク、フォームリンク、ボタンリンクなど）は、APIを呼び出しても反映されません。

PUT

/api/link/v2/update 

{
    "linkId": "4Rt3",
    "domain": "https://vvd.bz",
    "ttl": "new title",
    "memo": "new my memo"
}

Request Parameters

linkIdstringrequired
リンクIDです。
URLが「https://vvd.bz/fML」の場合、リンクIDは fML です。
domainstringrequired
Default:https://vvd.bz
リンクドメインです。
redirectTypeinteger
Default:302
Enum:
200301302
リダイレクト方式です。
詳細は用語集ページをご確認ください。
この機能はパーソナルプラン以上でご利用いただけます。
grpIdxinteger
リンクをグループ化する際に使用します。
グループIDXはグループ一覧APIを呼び出すか、ダッシュボードで確認できます。
urlstring
元のURLです。最大3,000バイトまで入力可能です。
この機能はプレミアムプラン以上でご利用いただけます。
ttlstring
リンクタイトルです。
descriptionstring
redirectTypeの値が200の場合、descriptionメタタグを設定できます。
metaImgstring
redirectTypeの値が200の場合、imageメタタグを設定できます。
画像URLは必ずhttps://で始まる必要があります。
memostring
リンク管理用のメモです。
notfSubscYnstring
Default:N
Enum:
YN
プッシュ購読リンクかどうかを指定します。
値がYの場合、元のURLに移動する前にランディングページが開き、ユーザーにプッシュ通知の許可を求めます。
ユーザーが拒否またはキャンセルした場合は、即座に元のURLに移動します。
pushNotifyYnstring
Default:N
Enum:
YN
クリック数のプッシュ通知を有効にするかを指定します。
値がYの場合、ダッシュボードの [設定 → 環境設定] で指定したクリック数に達するたびに、Vivoldiアプリがインストールされた端末に通知が送信されます。
この機能はパーソナルプラン以上でご利用いただけます。
mailNotifyYnstring
Default:N
Enum:
YN
クリック数のメール通知を有効にするかを指定します。
値がYの場合、[設定 → 環境設定]で指定したクリック数に達するたびにメールで通知されます。
この機能はパーソナルプラン以上でご利用いただけます。
webhookEnableYnstring
Default:N
Enum:
YN
Webhook の有効化設定。
グローバル Webhook が有効になっている必要があります。
この機能はエンタープライズプランでのみ利用可能です。
webhookMetricstring
Default:C
Enum:
CP
Webhook の受信基準。
C:クリック数基準、P:ユーザー数基準（ユニーククリック数）。
webhookFrequencyinteger
Default:1
Enum:
1501002003005001000
Webhook の受信頻度。
1:毎回クリック時、50:50回ごと、100:100回ごと、300:300回ごと、500:500回ごと、1000:1,000回ごと。
delYmdtdatetime
リンクの削除予定日です。
指定した日付を過ぎると、リンクはシステムによって自動的に削除されます。
例: 2025-08-30 23:59:59 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

codeinteger
応答コード: 0 = 成功、それ以外の値 = エラー
messagestring
応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
resultnull