Wired Plus API Documentation

Raise a Technical Question with the Support Team

API v1 Guide

Account

Automation

Contacts

Dynamic Rows

Lists

Campaigns

Transactional Emails

Lead Score

Products

Carts

Orders

Custom Fields

POST GetSuppressedContacts

Retrieves a list of suppressed contacts after a specified date.

Input and output parameters

The input and output parameters for this method are:

*denotes required field.

Input Parameter Name Type/Info
startdate* DateTime. e.g. '2017-08-08 00:00:00'
withfulldata value = 'true' or 'false'


returns custom fields and log data (suppression info).
select integer(1). Number of items to return, maximum of 500
skip integer(1). Number of records to skip
Outputs:
  • id - contact ID
  • create_date - when a contact was created
  • update_date - when a contact was updated
  • first_name
  • last_name
  • name
  • email (the email address of the contact)
  • opt_in (status of the opt in of the user, set to 0 for not opted in, 1 is opted in)
  • opt_in_date (the date the contact was opted in)
  • status (the status of the contact)
  • error_log - reason for the suppression
  • error_date - when a contact was suppressed

Examples

Curl

    
    
        
curl --request POST \
  --url https://api.wiredplus.com/v1/GetSuppressedContacts \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form 'withfulldata=true' \
  --form 'select=10' \
  --form 'skip=0' \
  --form 'startdate=2015-08-08 16:59:00'

PHP

    
    

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.wiredplus.com/v1/GetSuppressedContacts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"withfulldata\"\r\n\r\ntrue\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"select\"\r\n\r\n10\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"skip\"\r\n\r\n0\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"startdate\"\r\n\r\n2015-08-08 16:59:00\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--",
  CURLOPT_HTTPHEADER => array(
    "content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

jQuery

    
    

var form = new FormData();
form.append("withfulldata", "true");
form.append("select", "10");
form.append("skip", "0");
form.append("startdate", "2015-08-08 16:59:00");

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://api.wiredplus.com/v1/GetSuppressedContacts",
  "method": "POST",
  "headers": {},
  "processData": false,
  "contentType": false,
  "mimeType": "multipart/form-data",
  "data": form
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Result Format JSON

 

[
    {
        "id": "101",
        "create_date": "2018-10-02 15:23:12",
        "update_date": "2018-10-23 11:15:01",
        "first_name": "Ferris",
        "last_name": "Bueller",
        "name": "Ferris Bueller",
        "email": "random1@adomain.com",
        "opt_in": "2",
        "opt_in_date": "2018-10-10 23:04:19",
        "status": "Unsubscribed",
        "error_log": "Unsubscribed - Campaign Oct #1",
        "error_date": "2018-10-23 11:15:01"
    },
    {
        "id": "102",
        "create_date": "2018-10-14 10:34:53",
        "update_date": "2018-10-19 18:44:05",
        "first_name": "Sawyer",
        "last_name": "Tom",
        "name": "Sawyer Tom",
        "email": "random2@adomain.com",
        "opt_in": "1",
        "opt_in_date": "",
        "status": "Dropped",
        "error_log": "Bounced - Campaign Oct #2",
        "error_date": "2018-10-23 11:15:01"
    }
]