スタンプ削除API

スタンプ削除APIは、発行済みスタンプを完全に削除する機能です。

削除されたスタンプは復元できず、関連するスタンプ履歴もすべて削除されます。
複数のスタンプをまとめて削除する場合はダッシュボードをご利用ください。

このAPIはパーソナルプラン以上で利用できます。

DELETE

/api/stamp/v1/delete?stampIdx={stampIdx} 


DELETE /api/stamp/v1/delete
        ?stampIdx=394

Request Parameters

stampIdx integer required
スタンプIDX。 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

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

スタンプ削除が必要な場面

スタンプ削除は単なるデータ整理ではありません。
ユーザーにとっては、これまでに貯めたスタンプが消えることを意味します。削除APIを実行する前に以下を確認してください。

削除が適切なケース

  • テスト目的で作成したスタンプ
  • 重複または誤発行でユーザーに公開されていないスタンプ
  • すでに特典利用が完了し不要となったスタンプ

削除ではなく更新APIを使うべきケース

  • ユーザーがすでにスタンプを保有している場合 → activeYn を N に設定して無効化
  • 有効期限のみ調整したい場合 → endYmd を更新
  • 一時的に利用を停止したい場合 → activeYn を無効化し、必要に応じて再有効化

本番環境では慎重に使用してください。
削除は元に戻せないため、ユーザーデータに紐づくスタンプは無効化を優先してください。

運用上の注意ポイント

スタンプデータはユーザーの行動履歴と密接に関連しているため、削除は慎重に行う必要があります。

  • 削除によりリワード条件の判定に影響が出る可能性があります
  • 累積型キャンペーンでは結果が変わる場合があります
  • ユーザーからの問い合わせやクレーム発生リスクを考慮する必要があります

可能であれば削除ではなく、状態変更または 更新API の利用を優先してください。

stampIdxの確認方法

stampIdx はスタンプ作成時のレスポンスで返される一意の識別子です。

保存していない場合は、ダッシュボードから該当スタンプを確認できます。

削除は元に戻せないため、API実行前にstampIdxが正しいスタンプを指しているか必ず確認してください。

活用例

  • 誤付与データの削除: システムエラーなどで重複付与されたスタンプを削除
  • テストデータの整理: 開発・検証（QA）で作成されたスタンプを削除
  • キャンペーンデータの整理: 終了または期限切れのキャンペーンに不要なスタンプを削除