Classic/VPC環境で利用できます。
作成された受信者グループを削除します。グループに含まれるメールアドレスは削除されず、そのグループとの関連情報のみ削除されます。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| DELETE | /address-book/recipient-groups |
リクエストヘッダ
Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、Cloud Outbound Mailerのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
groupName |
String | Required | 削除する受信者グループの名前 |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request DELETE 'https://mail.apigw.ntruss.com/api/v1/address-book/recipient-groups?groupName=20代' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
totalAddressCount |
Integer | - | 総メールアドレス数 |
groups |
List | - | 受信者グループ情報 |
レスポンスステータスコード
Cloud Outbound Mailer APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Outbound Mailerのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"totalAddressCount": 4300,
"groups": [
{
"sid": 155,
"groupName": "10代",
"addressCount": 3900
},
{
"sid": 159,
"groupName": "男性",
"addressCount": 1000
}
}