リンクグループ削除API
不要になったリンクグループを削除するためのAPIです。
グループ内のリンクは削除されずそのまま維持されるため、構造整理を安全に行えます。
DELETE
/api/link-group/v1/delete?grpIdx={grpIdx}
DELETE /api/link-group/v1/delete
?grpIdx=5066
Request Parameters
- grpIdx integer required
- 削除するリンクグループのIDXです。
{
"code": 0,
"message": "",
"result": null
}
Response Parameters
- code integer
- 応答コード: 0 = 成功、それ以外の値 = エラー
- message string
- 応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
- result null
このAPIを利用する場面
運用が終了したリンクグループを整理する際に利用します。
終了したキャンペーングループの削除や、開発・テストで作成した一時グループの整理に適しています。
既存のグループ構成を見直して再構築する際にも有効です。
リンク自体は維持されるため、運用中のリンクに影響を与えません。
グループ削除とリンク削除の違い
リンク削除APIはリンク自体を削除し、短縮URLへアクセスできなくなります。
一方、リンクグループ削除APIはグループ構造のみを削除し、リンクはそのまま維持されます。
リンクデータを完全に削除する場合はリンク削除APIを、構造だけ整理したい場合はリンクグループ削除APIを利用してください。
削除時の動作
このAPIはデータ削除ではなく、グループ構造を削除する動作を行います。
- グループのみ削除されます
- グループ内のリンクはそのまま維持されます
- リンクはグループ未所属の状態になります
リダイレクトや統計取得などの動作には影響しません。
ただし、有効期限・パスワード・Webhookなどのグループ共通設定は削除されます。
利用時の注意点
- 削除したグループは復元できません。削除前に
grpIdxを必ず確認してください - グループ内のリンクは削除されません
- グループ単位で適用されていた設定はすべて削除されます
- 運用中のリンクがグループ設定に依存している場合、動作に影響が出る可能性があります
事前に各リンクへ必要な設定を適用した上でグループを削除することを推奨します。