Classic/VPC環境で利用できます。
広告メールを受信拒否するメールアドレスを登録します。登録されたメールアドレスは広告メールが受信拒否されます。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /unsubscribers |
リクエストヘッダ
Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、Cloud Outbound Mailerのリクエストヘッダをご参照ください。
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
blockedReceivers |
List[String] | Required | 登録対象の受信者メールアドレスリスト |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://mail.apigw.ntruss.com/api/v1/unsubscribers' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data-raw '{
"blockedReceivers":[
"xxx@naver.com",
"xxx@daum.net"
]
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
count |
Integer | - | 登録リクエストされたメールアドレスのうち、受信拒否リストに登録されたメールアドレス数 |
requestCount |
Integer | - | 登録リクエストされたメールアドレス数 |
ignoreCount |
Integer | - | 登録リクエストされたメールアドレスのうち、登録されていないメールアドレス数 |
レスポンスステータスコード
Cloud Outbound Mailer APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Outbound Mailerのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"count": 100,
"requestCount": 100,
"ignoreCount": 0
}