getUnsubscribersList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Get the email addresses included in the unsubscribe list.

Request

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

Method	URI
GET	/unsubscribers

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
`startUtc`	Long	Optional	Starting point for unsubscribe registration date and time An integer representing the elapsed time since January 1, 1970 00:00:00 UTC to the nearest millisecond `startUtc` or `startDateTime` must be entered Take precedence over the `startDateTime` value
`startDateTime`	String	Optional	Starting point for unsubscribe registration date and time (UTC:00) Allowed formats yyyy-MM-dd yyyy-MM-dd HH:mm yyyy-MM-dd HH:mm:ss.SSS yyyy-MM-dd HH:mm:ss SSS `startUtc` or `startDateTime` must be entered `startUtc` value takes precedence
`endUtc`	Long	Optional	Ending point for unsubscribe registration date and time An integer representing the elapsed time since January 1, 1970 00:00:00 UTC to the nearest millisecond `endUtc` or `endDateTime` must be entered Take precedence over the `endDateTime` value
`endDateTime`	String	Optional	Ending point for unsubscribe registration date and time (UTC:00) Allowed formats yyyy-MM-dd yyyy-MM-dd HH:mm yyyy-MM-dd HH:mm:ss.SSS yyyy-MM-dd HH:mm:ss SSS `endUtc` or `endDateTime` must be entered `endUtc` value takes precedence
`emailAddress`	String	Optional	Specific email address to search
`isRegByManager`	Boolean	Optional	Whether it is registered by the admin `true` \| `false` `true`: registered by the admin `false`: registered by the recipient
`size`	Integer	Optional	Number of records per page 10 (default)
`page`	Integer	Optional	Page index to view 0 or greater
`sort`	String	Optional	Sort by `createUtc` \| `isRegByManager` `createUtc`: unsubscribe registration date and time `isRegByManager`: whether it is registered by the admin property (,asc\|desc) format `asc` (default) Multiple sort criteria can be set

Request example

The following is a sample request.

curl --location --request GET 'https://mail.apigw.ntruss.com/api/v1/unsubscribers
?startDateTime=2018-11-01%2000:00
&size=5
&page=0
&endDateTime=2019-02-20%2023:59'
--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
`content`	List<UnsubscribersListResponse>	Optional	Details for the unsubscribe list
`totalElements`	Integer	Required	Total number of records
`totalPages`	Integer	Required	Total number of pages
`last`	Boolean	Required	It indicates whether this is the last page
`numberOfElements`	Integer	Required	Number of records in the current page
`first`	Boolean	Required	It indicates whether this is the first page
`sort`	List<Sort>	Required	Sort by
`size`	Integer	Required	Number of records per page
`number`	Integer	Required	Index of the current page 0 or greater

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.

{
   "content":[
      {
         "address":"shin.xxx@gmail.com",
         "blockDate":{
            "utc":1546569106178,
            "formattedDate":"2019-01-04",
            "formattedDateTime":"2019-01-04 11:31:46 178"
         },
         "isRegByManager":false
      },
      {
         "address":"shin.xxxx@navercorp.com",
         "blockDate":{
            "utc":1546569014158,
            "formattedDate":"2019-01-04",
            "formattedDateTime":"2019-01-04 11:30:14 158"
         },
         "isRegByManager":false
      },
      {
         "address":"xxxxx@aaa.com",
         "blockDate":{
            "utc":1544603441295,
            "formattedDate":"2018-12-12",
            "formattedDateTime":"2018-12-12 17:30:41 295"
         },
         "isRegByManager":true
      },
      {
         "address":"xxxxx@nnn.com",
         "blockDate":{
            "utc":1544603441295,
            "formattedDate":"2018-12-12",
            "formattedDateTime":"2018-12-12 17:30:41 295"
         },
         "isRegByManager":true
      }
   ],
   "totalElements":4,
   "totalPages":1,
   "last":true,
   "numberOfElements":4,
   "first":true,
   "sort":[
      {
         "direction":"DESC",
         "property":"createUtc",
         "ignoreCase":false,
         "nullHandling":"NATIVE",
         "ascending":false,
         "descending":true
      }
   ],
   "size":10,
   "number":0
}

Was this article helpful?

What's Next

deleteUnsubscribers

Table of contents

Request
Response