registerUnsubscribers
- Print
- PDF
registerUnsubscribers
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Register an email address to unsubscribe from advertising emails. The registered email address will be unsubscribed from advertising emails.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| POST | /unsubscribers |
Request headers
For headers common to Cloud Outbound Mailer APIs, see Cloud Outbound Mailer request headers.
Request body
The following describes the request body.
| Field | Type | Required | Description |
|---|---|---|---|
blockedReceivers | List<String> | Required | List of recipient email addresses to register |
Request example
The following is a sample request.
curl --location --request POST 'https://mail.apigw.ntruss.com/api/v1/unsubscribers'
--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 '{
"blockedReceivers":[
"xxx@naver.com",
"xxx@daum.net"
]
}'
Response
The following describes the response format.
Response body
The following describes the response body.
| Field | Type | Required | Description |
|---|---|---|---|
count | Integer | Required | Number of email addresses registered to the unsubscribed list among those requested for registration |
requestCount | Integer | Required | Total number of email addresses requested for registration |
ignoreCount | Integer | Required | Number of email addresses not registered among those requested for registration |
Response status codes
The following describes the response status codes.
| HTTP status code | Code | Description |
|---|---|---|
| 201 | - | 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.
{
"count": 100,
"requestCount": 100,
"ignoreCount": 0
}
Was this article helpful?