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

This section describes the request format. The method and URI are as follows:

Request headers

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

Request body

You can include the following data in the body of your request:

Request example

The request example is as follows:

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":"10",
      "emailAddresses":[
        "xxx@naver.com",
        ...
      ]
    },
    {
      "groupName":"Male",
      "emailAddresses":[
        "xxx@daum.net",
        ...
      ]
    }
  ]
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

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 response example is as follows:

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