Add email to suppression list
Description
Adds an email address to a suppression list.
Request URL
Method: POST
https://example.com/api/v1.1/suppresses/email_add
Request parameters
Parameter | Type | Example | Required | Description |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Yes | API token |
string | "john@example.com" | Yes | Email address | |
format | string | "json" | No | Response data format. By default – json |
id | int | 1 | Yes | suppression list ID |
Request example
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"email": "john@example.com",
"id": 1
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<email>john@example.com</email>
<id>1</id>
</xml>
Response example
- JSON
- XML
{
"data": {
"john@example.com": true
},
"error": 0,
"error_text": "Successful operation"
}
<xml>
<data>
<john@example.com>false</john@example.com>
</data>
<error>0</error>
<error_text>Successful operation</error_text>
</xml>
Response parameters
Parameter | Type | Description |
---|---|---|
error | int | Error code |
error_text | string | Error text |