createAddressBook

Available in Classic and VPC

Create an address book by entering recipient groups and addresses. The address book status right before creating an address book is returned as a response, and the creation task is processed asynchronously.
You can also change the address book that was created. You can do this by adding a new address to an existing recipient group or creating a new recipient group.

Request

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

Request headers

For information about the headers common to all Cloud Outbound Mailer APIs, see Cloud Outbound Mailer request headers.

Request body

The following describes the request body.

Request example

The following is a sample request.

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

Response

The following describes the response format.

Response body

The following describes the response body.

Response status codes

For information about the HTTP status codes common to all Cloud Outbound Mailer APIs, see Cloud Outbound Mailer response status codes.

Response example

The following is a sample response.

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