Get information about a blocklist entry

1 min

GET

https://api.campaign.episerver.net/rest/{clientId}/blacklistentries/{entry}

Get detailed information about a blocklist entry, such as pattern, reason for blocklisting or creation date.

Path Parameters

clientIdstringrequired
Description
Client ID
entrystringrequired
Description
Blocklist entry patternNote: If the blocklist entry pattern contains special characters, the pattern must be URL-encoded. For example, use the code %2f for a forward slash (/), %252f for a double slash (//), %2B for a plus sign (+) etc.

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsonapplication/vnd.optivo.broadmail.v1+json

Responses

200The blocklist entry was retrieved successfully.

RestBlacklistEntry
- mailingGroupIdinteger<int64>
  Description
  Client ID
  Format
  int64
- patternstring
  Description
  Pattern for all mailing addresses that push into the blocklist
- reasonstring
  Description
  Reason for adding a pattern into the blocklist
- createdstring<date-time>
  Description
  Date and time of creation
  Format
  date-time
- modifiedstring<date-time>
  Description
  Date and time of modification
  Format
  date-time
- linksobject[]
  - uriBuilderobject
  - relsstring[]
  - relstring
  - typestring
  - paramsmap<string, string>
  - titlestring
  - uristring<uri>
    Format
    uri

404The blocklist entry could not be found. Ensure that the required parameters such as "entry" are correct and the blocklist entry exists.

curl

curl --request GET \
     --url https://api.campaign.episerver.net/rest/{clientId}/blacklistentries/{entry} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.campaign.episerver.net/rest/{clientId}/blacklistentries/{entry}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.campaign.episerver.net/rest/{clientId}/blacklistentries/{entry}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

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

python

import requests
import json

url = "https://api.campaign.episerver.net/rest/{clientId}/blacklistentries/{entry}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// The blocklist entry was retrieved successfully.
{
  "mailingGroupId": "",
  "pattern": "",
  "reason": "",
  "created": "",
  "modified": "",
  "links": [
    {
      "uriBuilder": {},
      "rels": [
        ""
      ],
      "rel": "",
      "type": "",
      "params": "",
      "title": "",
      "uri": ""
    }
  ]
}

404

// The blocklist entry could not be found. Ensure that the required parameters such as "entry" are correct and the blocklist entry exists.