registerUnsubscribers
- Print
- PDF
registerUnsubscribers
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Register the unsubscribe email.
POST https://{endpoint}/unsubscribers
Request
Request Parameters
Parameter | Required | Type | Limitation | Description |
---|---|---|---|---|
blockedReceivers | Yes | List<String> | Email Address Format | Email Address List |
Response
HTTP status code | Description |
---|---|
201 | Address registration complete |
400 | Authentication failed, invalid request. |
500 | Server error |
Example
Request Example
POST https://mail.apigw.ntruss.com/api/v1/unsubscribers
{
"blockedReceivers":[
"xxx@naver.com",
"xxx@daum.net",
...
]
}
Response Example
{
"count": 100,
"requestCount": 100,
"ignoreCount": 0
}
Properties
Property | Required | Type | Limitation | Description |
---|---|---|---|---|
count | Yes | Integer | The number of mails that you have requested to register that are registered in the Deny of Receive List | |
requestCount | Yes | Integer | Number of mails requested by the user for registration | |
ignoreCount | Yes | Integer | Number of unregistered mails |
Error Codes
HTTP status code | Return code | Response message |
---|---|---|
400 | 77101 | Error in login information |
400 | 77102 | BAD_REQUEST |
400 | 77103 | Resource not found |
403 | 77201 | No permissions |
403 | 77202 | No subscription |
405 | 77001 | METHOD_NOT_ALLOWED |
415 | 77002 | UNSUPPORTED_MEDIA_TYPE |
500 | 77301 | Default project not found |
500 | 77302 | Error in working with external system API |
500 | 77303 | Other INTERNAL_SERVER_ERROR |
Was this article helpful?