Blacklist | Api reference MessageFlow

Api reference MessageFlow

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

Authorization

Query parameters

Response

Request was successfully processed

Body

metaobject

Additional data

dataarray of object

Request

var client = new RestClient("https://api.redlink.pl/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);

Response

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

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

Authorization

Query parameters

Response

Request was successfully processed

Body

metaobject

Additional data

dataarray of object

Request

var client = new RestClient("https://api.redlink.pl/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);

Response

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

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}

Authorization

Path parameters

smtp*string

The name of your smtp account.

Example: "1.test.smtp"

Body

idarray of string

List of emails that should be deleted from blacklist

Response

Request was successfully processed

Body

metaobject

Additional data

Request

var client = new RestClient("https://api.redlink.pl/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\":[\"mail@mail.com\"]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Response

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