リンク削除API

短縮リンクを完全に削除するAPIです。

削除されたリンクは復元できず、アクセスは即時に無効化されます。
削除前にリンクが使用中でないことを必ずご確認ください。

重要なリンクは、再作成可能なブランドリンク（カスタムID）での運用を推奨します。

不要なリンクの整理やアクセス制御が必要な場合に利用します。

DELETE

/api/link/v1/delete?linkId={linkId}&domain={domain} 


DELETE /api/link/v1/delete
        ?linkId=4Rt3
        &domain=https%3A%2F%2Fvvd.bz

Request Parameters

linkId string required
リンクIDです。
URLが「https://vvd.bz/fML」の場合、リンクIDは fML です。
domain string required
Default:https://vvd.bz
リンクドメインです。 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

code integer
応答コード: 0 = 成功、それ以外の値 = エラー
message string
応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
result null

このAPIを利用する場面

次のような場面でご利用ください。

  • 終了したイベントやキャンペーンのリンクを整理したいとき
  • 誤って作成したリンクを削除したいとき
  • セキュリティ上、即時に無効化する必要があるリンクを遮断したいとき
  • 不要なリンクを整理してアカウントを管理したいとき
削除されたリンクは即時に無効化され、共有済みのURLも利用できなくなります。
リンク先のみ変更したい場合は、削除ではなくリンク更新API（Update API）の利用をおすすめします。

リンク更新APIとの違い

削除APIはリンクを完全に削除し、更新APIは内容を変更します。

  • 削除: 短縮リンク自体が完全に削除されます。アクセスするとエラーページが表示され、復元はできません。
  • 更新: リンクURLはそのままに、リンク先や設定のみ変更されます。共有済みリンクもそのまま利用できます。

削除の影響

リンクを削除すると、次の影響が発生します。

  • 短縮URLは即時に無効化されます
  • アクセスするとエラーが表示される、またはページが表示されなくなります
  • 関連する統計データの閲覧が制限される場合があります
  • 外部に共有されたリンクもすべて無効になります
削除は元に戻せないため、慎重に実行してください。

利用時の注意点

削除は元に戻せないため、事前にご確認ください。

  • linkIdとdomainが正しいか確認
  • 削除後の復元はできません
  • 重要なリンクはbrandLinkIdでカスタムIDを設定して作成することを推奨します
  • 一括削除時は影響範囲を事前に確認してください
本番環境では削除権限の制限を推奨します。