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.gov-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
}
}