配信停止アドレス登録

機能説明

配信を停止するメールアドレスを登録します。
ここで登録したメールアドレスの配信停止処理は、配信メール登録APIのリクエストに含まれているメールアドレスにのみ作用します。
既にAPIが受け付け、送信処理が始まっているメールアドレスに対しては影響しません。
既に登録済みのアドレスを登録した場合は、成功扱いになります。

リクエスト

エンドポイント

/v1/cancels

HTTPメソッド

POSTもしくはPUT

リクエストボディ

JSON形式であること
要素名
要素数
制限
説明
address 文字列 1
  • EMAILアドレス形式の文字列であること
  • 最大256文字
メールアドレス

レスポンス

ステータスコード

状態
コード
成功 200
パラメータのバリデーションエラー 400
TXTレコードの検証に失敗 400
指定したセレクタが存在しない 400
既に有効化されている 400
認証失敗 401
存在しないエンドポイント 404
許可されていないHTTPメソッド 405
システムエラーが発生した 500
システムが一時的にサービスを提供できない状態になっている 503
システムのタイムアウト 504

レスポンスボディ

成功
{"address":"foo@example.com","code":201}
失敗
{"code":400,"error":"the address is not email address"}