Adds an email address to the suppression list. You can always remove this address from the suppression list later using the suppression-delete method.
https://dns-name/suppression/createRequest Body
POST https://dns-name/suppression/create
Content-Type: application/json
X-API-KEY: Value
{
"email": "string",
"reason": "string",
"created": "string"
}Request Parameters
| Name | Type | Description |
|---|---|---|
| STRING REQUIRED | Email to add in suppression list | |
| reason | STRING REQUIRED | Cause of email being suppressed. One of: – unsubscribed: email is unsubscribed; – temporary_unavailable: the email address is unavailable. This means that over the next three days sending to this address will return an error. Email may be temporarily unavailable due to several reasons, e.g.: a. a previous email has been rejected by the recipient’s server for spam; b. the recipient’s mailbox is full or is not used; c. recipient’s domain does not accept mail; d. sending server was rejected due to blacklisting; – permanent_unavailable: the email address is permanently unavailable due to multiple hard bounces; – complained: the recipient reported spam in the previous emails; – blocked: sending to the email is prohibited by administration of GMS. We may add some new causes in the future. |
| created | STRING (UTC-DATA-TIME) | When suppression was created, in UTC timezone in “YYYY-MM-DD hh:mm:ss” format |
Response Body
{
"status": "string"
}HTTP Code 200:
| Email has been added to the suppression list |
Response Parameters
| Name | Type | Description |
|---|---|---|
| status | STRING REQUIRED | «Success» string |
HTTP Code default:
| Error occurred |
{
"status": "string",
"code": 0,
"message": "string"
}| Name | Type | Description |
|---|---|---|
| status | STRING REQUIRED | «Error» string |
| message | STRING REQUIRED | Human-readable error message in English |
| code | INTEGER REQUIRED | API Error code |