« Back to Documentation Overviewget_suppression_skiplist
Section: Suppressions
Version: 1.5.0
Skiplist is a set of masks for suppression. If contact’s email address matches any of those masks in message that uses this suppression then it will be skipped.
Parameters
|
---|
string | API_KEY |
object | string | suppression | SUPPRESSION_ID |
|
Return Value
|
---|
string | by.whole@email.com | 2010-01-01 00:00:00 |
string | by.local@ | 2010-01-01 00:00:00 |
string | @by.domain | 2010-01-01 00:00:00 |
string | 990420c537fd46a6c2af5b00ff94cf51 | 2010-01-01 00:00:00 |
string | #by_isp | 2010-01-01 00:00:00 |
Example Request JSON
[
"API_KEY",
{
"suppression": "SUPPRESSION_ID"
}
]
Example Response JSON
{
"by.whole@email.com": "2010-01-01 00:00:00",
"by.local@": "2010-01-01 00:00:00",
"@by.domain": "2010-01-01 00:00:00",
"990420c537fd46a6c2af5b00ff94cf51": "2010-01-01 00:00:00",
"#by_isp": "2010-01-01 00:00:00"
}
Example Error Response JSON
{
"code": -1,
"message": "Missing suppression"
}
Method-specific Errors
|
---|
Missing suppression |
API-wide Errors
|
---|
API key verification failed
| API key verification failed |
API client IP not allowed
| API client IP not allowed |
Invalid params
| Attribute params must be reference to hash |