Blacklist

Get blacklisted email addresses

Use this method to list all email addresses that are on your blacklist.

GEThttps://api.messageflow.com/v2.1/email/blacklist

Query parameters

Response

200401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

dataarray of Blacklist (object)

Request

var client = new RestClient("https://api.messageflow.com/v2.1/email/blacklist?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddHeader("application-key", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Response

{
  "meta": {
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "email": "text",
      "smtpAccount": "text",
      "reason": "text",
      "comment": "text",
      "counter": "text"
    }
  ]
}

C#

var client = new RestClient("https://api.messageflow.com/v2.1/email/blacklist?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Go

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.messageflow.com/v2.1/email/blacklist?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "REPLACE_KEY_VALUE")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Java

HttpResponse<String> response = Unirest.get("https://api.messageflow.com/v2.1/email/blacklist?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE")
  .header("authorization", "REPLACE_KEY_VALUE")
  .asString();

Node

var request = require("request");

var options = {
  method: 'GET',
  url: 'https://api.messageflow.com/v2.1/email/blacklist',
  qs: {
    offset: 'SOME_INTEGER_VALUE',
    limit: 'SOME_INTEGER_VALUE',
    smtpAccount: 'SOME_STRING_VALUE'
  },
  headers: {authorization: 'REPLACE_KEY_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.messageflow.com/v2.1/email/blacklist?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "authorization: REPLACE_KEY_VALUE"
  ),
));

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

curl_close($curl);

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

Python

import requests

url = "https://api.messageflow.com/v2.1/email/blacklist"

querystring = {"offset":"SOME_INTEGER_VALUE","limit":"SOME_INTEGER_VALUE","smtpAccount":"SOME_STRING_VALUE"}

headers = {'authorization': 'REPLACE_KEY_VALUE'}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.messageflow.com/v2.1/email/blacklist?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'REPLACE_KEY_VALUE'

response = http.request(request)
puts response.read_body

Shell

http GET 'https://api.messageflow.com/v2.1/email/blacklist?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE' \
  authorization:REPLACE_KEY_VALUEuthorization: REPLACE_KEY_VALUE'

Add emails to blacklist

Use this method to add email addresses to the blacklist. Each email address in the blacklist will be omitted in future transactional email sending.

POSThttps://api.messageflow.com/v2.1/email/blacklist

Query parameters

Response

200207401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

dataarray of Blacklist (object)

Request

var client = new RestClient("https://api.messageflow.com/v2.1/email/blacklist?email=SOME_STRING_VALUE&smtpAccount=SOME_STRING_VALUE&reason=SOME_STRING_VALUE&comment=SOME_STRING_VALUE");
var request = new RestRequest(Method.POST);
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddHeader("application-key", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Response

{
  "meta": {
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "email": "text",
      "smtpAccount": "text",
      "reason": "text",
      "comment": "text",
      "counter": "text"
    }
  ]
}

C#

var client = new RestClient("https://api.messageflow.com/v2.1/email/blacklist?email=SOME_STRING_VALUE&smtpAccount=SOME_STRING_VALUE&reason=SOME_STRING_VALUE&comment=SOME_STRING_VALUE");
var request = new RestRequest(Method.POST);
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Go

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.messageflow.com/v2.1/email/blacklist?email=SOME_STRING_VALUE&smtpAccount=SOME_STRING_VALUE&reason=SOME_STRING_VALUE&comment=SOME_STRING_VALUE"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("authorization", "REPLACE_KEY_VALUE")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Java

HttpResponse<String> response = Unirest.post("https://api.messageflow.com/v2.1/email/blacklist?email=SOME_STRING_VALUE&smtpAccount=SOME_STRING_VALUE&reason=SOME_STRING_VALUE&comment=SOME_STRING_VALUE")
  .header("authorization", "REPLACE_KEY_VALUE")
  .asString();

Node

var request = require("request");

var options = {
  method: 'POST',
  url: 'https://api.messageflow.com/v2.1/email/blacklist',
  qs: {
    email: 'SOME_STRING_VALUE',
    smtpAccount: 'SOME_STRING_VALUE',
    reason: 'SOME_STRING_VALUE',
    comment: 'SOME_STRING_VALUE'
  },
  headers: {authorization: 'REPLACE_KEY_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.messageflow.com/v2.1/email/blacklist?email=SOME_STRING_VALUE&smtpAccount=SOME_STRING_VALUE&reason=SOME_STRING_VALUE&comment=SOME_STRING_VALUE",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => array(
    "authorization: REPLACE_KEY_VALUE"
  ),
));

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

curl_close($curl);

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

Python

import requests

url = "https://api.messageflow.com/v2.1/email/blacklist"

querystring = {"email":"SOME_STRING_VALUE","smtpAccount":"SOME_STRING_VALUE","reason":"SOME_STRING_VALUE","comment":"SOME_STRING_VALUE"}

headers = {'authorization': 'REPLACE_KEY_VALUE'}

response = requests.request("POST", url, headers=headers, params=querystring)

print(response.text)

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.messageflow.com/v2.1/email/blacklist?email=SOME_STRING_VALUE&smtpAccount=SOME_STRING_VALUE&reason=SOME_STRING_VALUE&comment=SOME_STRING_VALUE")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["authorization"] = 'REPLACE_KEY_VALUE'

response = http.request(request)
puts response.read_body

Shell

http POST 'https://api.messageflow.com/v2.1/email/blacklist?email=SOME_STRING_VALUE&smtpAccount=SOME_STRING_VALUE&reason=SOME_STRING_VALUE&comment=SOME_STRING_VALUE' \
  authorization:REPLACE_KEY_VALUEuthorization: REPLACE_KEY_VALUE'

Delete email addresses from blacklist

Use this method to delete email addresses from the blacklist so they won’t be omitted in the future transactional email sending.

DELETEhttps://api.messageflow.com/v2.1/email/blacklist/{smtp}

Path parameters

smtp*string

The name of your smtp account.

Body

application/json

idarray of string

List of emails that should be deleted from blacklist

Response

200207401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

Request

var client = new RestClient("https://api.messageflow.com/v2.1/email/blacklist/%7Bsmtp%7D");
var request = new RestRequest(Method.DELETE);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddHeader("application-key", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"id\":[\"[e-mail]\"]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Response

{
  "meta": {
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  }
}

C#

var client = new RestClient("https://api.messageflow.com/v2.1/email/blacklist/%7Bsmtp%7D");
var request = new RestRequest(Method.DELETE);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"id\":[\"[e-mail]\"]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Go

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.messageflow.com/v2.1/email/blacklist/%7Bsmtp%7D"

	payload := strings.NewReader("{\"id\":[\"[e-mail]\"]}")

	req, _ := http.NewRequest("DELETE", url, payload)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "REPLACE_KEY_VALUE")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Java

HttpResponse<String> response = Unirest.delete("https://api.messageflow.com/v2.1/email/blacklist/%7Bsmtp%7D")
  .header("content-type", "application/json")
  .header("authorization", "REPLACE_KEY_VALUE")
  .body("{\"id\":[\"[e-mail]\"]}")
  .asString();

Node

var request = require("request");

var options = {
  method: 'DELETE',
  url: 'https://api.messageflow.com/v2.1/email/blacklist/%7Bsmtp%7D',
  headers: {'content-type': 'application/json', authorization: 'REPLACE_KEY_VALUE'},
  body: {id: ['[e-mail]']},
  json: true
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.messageflow.com/v2.1/email/blacklist/%7Bsmtp%7D",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => "{\"id\":[\"[e-mail]\"]}",
  CURLOPT_HTTPHEADER => array(
    "authorization: REPLACE_KEY_VALUE",
    "content-type: application/json"
  ),
));

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

curl_close($curl);

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

Python

import requests

url = "https://api.messageflow.com/v2.1/email/blacklist/%7Bsmtp%7D"

payload = "{\"id\":[\"[e-mail]\"]}"
headers = {
    'content-type': "application/json",
    'authorization': "REPLACE_KEY_VALUE"
    }

response = requests.request("DELETE", url, data=payload, headers=headers)

print(response.text)

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.messageflow.com/v2.1/email/blacklist/%7Bsmtp%7D")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Delete.new(url)
request["content-type"] = 'application/json'
request["authorization"] = 'REPLACE_KEY_VALUE'
request.body = "{\"id\":[\"[e-mail]\"]}"

response = http.request(request)
puts response.read_body

Shell

echo '{"id":["[e-mail]"]}' |  \
  http DELETE https://api.messageflow.com/v2.1/email/blacklist/%7Bsmtp%7D \
  authorization:REPLACE_KEY_VALUE \
  content-type:application/jsonjson' \
  --data '{"id":["[e-mail]"]}'