Gets a reason and date of email suppression.
https://dns-name/suppression/getRequest Body
POST https://dns-name/suppression/get
Content-Type: application/json
X-API-KEY: Value
{
"searching": true,
"receiver_email": "string"
}Request Parameters
| Name | Type | Description |
|---|---|---|
| String Required | Email to get suppression details for | |
| searching | BOOLEAN | If a user has projects functionality enabled, he/she can pass all_projects=true to search in all projects’ data |
Response Body
{
"status": "string",
"email": "string",
"suppressions": [
{
"reason": "string",
"source": "string",
"created": "string",
"project_id": "string",
"is_deletable": true
}
]
}HTTP Code 200:
| Method call has succeeded (but suppressions array can be empty if sending to email is not suppressed) |
Response Parameters
| Name | Type | Description |
|---|---|---|
| status | STRING REQUIRED | «Success» string |
| STRING REQUIRED | The email for which suppression details were requested | |
| suppressions | ARRAY REQUIRED | Array of suppression objects |
| »project_id | STRING | Unqiue project identifier, ASCII string up to 36 characters long |
| 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. |
| »source | STRING REQUIRED | Source of email being suppressed. One of: user – suppressed by user with SUPPRESSION-SET system – sending to the email is prohibited by system, for example due to multiple hard bounces; subscriber – the recipient reported spam or unsubscribed in the previous emails. |
| »is_deletable | BOOLEAN REQUIRED | Is it possible to delete this suppression by calling suppression/delete method |
| created | STRING (UTC-DATA-TIME) | When suppression was created, in UTC timezone in “YYYY-MM-DD hh:mm:ss” format |
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 |