deleteRecipientGroup

Prev Next

Available in Classic and VPC

Delete the created recipient group. The email addresses contained within the group are not deleted, only the information associated with the group.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
DELETE /address-book/recipient-groups

Request headers

For headers common to Cloud Outbound Mailer APIs, see Cloud Outbound Mailer request headers.

Request query parameters

The following describes the parameters.

Field Type Required Description
groupName String Required Name of the recipient group to delete

Request example

The following is a sample request.

curl --location --request DELETE 'https://mail.apigw.ntruss.com/api/v1/address-book/recipient-groups
?groupName=20s'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field Type Required Description
totalAddressCount Integer Required Total number of email addresses
groups List<AddressBookResponse> Optional Recipient group information

Response status codes

The following describes the response status codes.

HTTP status code Code Description
200 - Request succeeded
400 - Authentication failed, invalid request
400 77101 Error in login information
400 77102 Request error
400 77103 Requested resource does not exist
403 77201 No permissions to the requested resource
403 77202 Call from a user who hasn't subscribed to the email service
405 77001 Unsupported method type
415 77002 Unsupported media type
500 - Server error
500 77301 Default project does not exist
500 77302 External system API integration error
500 77303 Other internal server error

Response example

The following is a sample response.

{
  "totalAddressCount": 4300,
  "groups": [
    {
      "sid": 155,
      "groupName": "Teens",
      "addressCount": 3900
    },
    {
      "sid": 159,
      "groupName": "Male",
      "addressCount": 1000
    }
}