deleteAddress

Classic/VPC環境で利用できます。

登録された受信者メールアドレスを削除します。削除対象を含む受信者グループがある場合、そのグループの関連情報が変更されます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
DELETE	/address-book/address

リクエストヘッダ

Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、Cloud Outbound Mailerのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`emailAddresses`	List[String]	Required	削除対象の受信者メールアドレスリスト

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request DELETE 'https://mail.apigw.ntruss.com/api/v1/address-book/address' \
--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 '{
  "emailAddresses":[
    "xxx@naver.com",
    "xxx@daum.net",
    ...
  ]
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`totalAddressCount`	Integer	Required	総メールアドレス数
`groups`	List	Optional	受信者グループ情報 AddressBookResponseを参照

レスポンスステータスコード

Cloud Outbound Mailer APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Outbound Mailerのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "totalAddressCount": 4300,
  "groups": [
    {
      "sid": 155,
      "groupName": "10代",
      "addressCount": 3900
    },
    {
      "sid": 159,
      "groupName": "男性",
      "addressCount": 1000
    }
}