ワンクリック登録解除者除外
機能説明
ワンクリック登録解除者リストに登録された配信先メールアドレスは、登録解除リクエストを受理後90日間、メール配信対象から除外されます。この期間中、特定のメールアドレスを再び配信可能にするのが本APIです。
配信を再開したいFromアドレスと配信先メールアドレスを指定し、配信対象に設定します。
設定の結果を確認するためには、ワンクリック登録解除者リスト取得:自動付与を使用して解除者リストを取得します。
メソッドとURL
メソッド | URL |
PUT | https://{HOST名}/re-subscribers |
リクエスト
ボディパラメーター
JSON形式で設定します。
項目 | 型 | 必須 | 説明 | ||||
header-from | String | ◯ | 要素to-addressに指定したメールアドレス宛に、配信を許可するFromアドレスを指定 | ||||
to-addresses | String Array | ◯ | 再配信を行うアドレス |
補足説明
to-addresses要素には複数のメールアドレスを指定可能です。
to-addresses要素には複数のメールアドレスを指定可能です。
レスポンス
ステータスコード
コード | メッセージ | 説明 |
204 | OK | 正常終了(※コンテンツはありません)。 |
400 | Bad Request | 構文不正。フォーマットやパラメーターの不正。 |
500 | Internal Server Error | 想定外のエラー。 しばらく経ってから再度実施し、状況が改善しなければ、弊社までお問い合わせください。 |
上記以外のステータスコードが返却される場合もあります。
その場合は、RFC2616規定のHTTPレスポンスステータスコード一覧をご確認ください。
サンプル
リクエスト
{
"header-from": "sender@example.com",
"to-addresses": [
"subscriber@receiver.example.com",
"subscriber2@receiver.example.com"
]
}
レスポンス
正常
コンテンツはありません。
エラー
{
"message": "Internal Server Error"
}
補足情報が返却されます。