Wooxy API v.3.0

Add A Contact To Email Black List

The Add A Contact To Email Black List method allows you to add a contact to the blacklist.

Request

POST

/v3/blacklist/add

IMPORTANT: Do not send more than 10 concurrent API requests.

Body Example

                                        {
    "records": [
        {
            "email": "user@example.com",
            "rejectType": "hard",
            "rawLog": "Text to describe reason for adding to Black List"
        }
    ]
}

Parameters

Title	Type	Description
records required	array	Array of objects. Each object will be processed and saved. In case of duplicated objects, duplicates will be ignored and no errors will be returned.
records.email required	string	`IMPORTANT:` should be `valid Email address`.
records.rejectType required	string	One of the available reasons for placing the email address in the Email Black List. `WARNING:` Minimum one rejectType (`hard` \| `complaint` \| `list-unsubscribe` ) is required: hard: Used to indicate that address is invalid or non-existing; complaint: Used to indicate that user complaint or asked to unsubscribe; list-unsubscribe: Used to indicate that the user unsubscribed by the list-unsubscribed mechanism. `NOTE:` The list-unsubscribe mechanism unsubscribes contacts only from mailings, not from the Email channel.
records.rawLog optional	string	Optional text description of the reason for placing the contact in suppression list. Up to 1024 symbols.

Response

                                        {
  "result": true
}

Parameters

Title	Type	Description
result	boolean	The value indicates that the email address was successfully added to the account Email Black List: true: Contact was successfully added to the Email Black List.

Method Errors

                                        {
   "result": false,
   "errors": [
      "Error description text"
   ]
}

Error
“Maximum count of records per transaction is 100, current {n}”
“Invalid RFC2822 email {email}”
“Allowed rejectType is {a llowed}, but {rejectType} given”
“Argument rawLog must be a string”
“Argument rawLog cannot be longest 1024 bytes”
“Invalid authorization token!”
“Internal server error”
“Bad Request”
“no matches found for access token {accessToken}”
“user {id} not enabled”
“no data found for key {userId} “
“access token check failed for key\/secret $key\/$accessToken”
“Argument {argument} required”

Code Examples

PHP

                $accessToken = "YOUR_API_KEY";
$url = 'https://api.wooxy.com/v3/blacklist/add';

$body = json_encode([
    'records' => [
        [
            "email"  => "user@example.com",
            "rejectType"   => "hard",
            "rawLog" => "Text to describe reason for adding to Black List"
        ],
    ],
]);

/**
 * Request Example
 */
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
//curl_setopt($ch, CURLOPT_HEADER, true);
curl_setopt($ch, CURLOPT_INFILESIZE, null);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Access-Token: $accessToken",
    'Content-Type: application/json',
    'Content-Length: ' . strlen($body),
]);

$result = curl_exec($ch);
if ($result === false) {
    echo 'cURL error:' . curl_error($ch) . PHP_EOL;
} else {
    echo strval($result) . PHP_EOL;
}
curl_close($ch);