機能説明
登録済みの配信停止メールアドレスを削除します。
配信停止と判定されたメールアドレスを削除しても、配信停止したメールは配信されません。
削除したメールアドレス宛に、再度配信した場合は配信されます。
動線のサンプル
- アドレスAを配信停止アドレスに登録する。
- アドレスA宛てにメール①を配信する。
- メール①が配信停止になる。
- アドレスAを配信停止アドレスから削除する。
- アドレスA宛てにメール②を配信する。
得られる結果
4の配信停止アドレス削除後、5においてメール①は配信停止が確定しているため、配信されません。
メール②は、配信されるようになります。
リクエスト
エンドポイント
/v1/cancels?address=[URLエンコードしたメールアドレス]
HTTPメソッド
DELETE
リクエストボディ
なし
レスポンス
ステータスコード
状態
|
コード
|
---|---|
URLエンコードしたメールアドレスが登録されていない | 410 |
クエリパラメータのバリデーションエラー | 400 |
システムが一時的にサービスを提供できない状態になっている | 503 |
システムのタイムアウト | 504 |
システムエラーが発生した | 500 |
存在しないエンドポイント | 404 |
成功 | 204 |
許可されていないHTTPメソッド | 405 |
認証失敗 | 401 |
レスポンスボディ
成功
なし(コードは204番)
失敗
{"code":410,"error":"the address is not in cancel list"}