REST Email Marketing API Documentation

Suppression — Global — Check

Check if a single recipient is on a topic suppression list.

HTTP VERB

Get

URL

/API/Rest/Suppression/Topic/Check

ARGUMENTS

emailAddress
topicName

Required permission

CreateEditMember

ERRORS

No Permission
Too many API calls
Database error
Unknown error

RETURNS

0 or 1. 0 not suppressed, 1 is suppressed.

EXAMPLE

Check if a recipient is on a topic suppression list.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/Suppression/Topic/Check?accountName=acme&login=ApiUser&emailAddress=joe@example.com&topicName=Weekly%20Specials";

// Reuse HttpClient for multiple requests in production code.
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, url))
{
	request.Headers.Add("Password", "YOUR_PASSWORD");

	using (HttpResponseMessage response = await client.SendAsync(request))
	{
		response.EnsureSuccessStatusCode();
		Console.WriteLine(await response.Content.ReadAsStringAsync());
	}
}

# encoding: utf-8
require 'rest-client'
require 'json'
							
url = 'https://example.com/API/Rest/Suppression/Topic/Check?accountName=acme&login=ApiUser&emailAddress=joe@aol.com&topicName=Weekly%20Specials'
response = RestClient.get(url, {:Password => "YOUR_PASSWORD"})
puts response

import requests
url = "https://example.com/API/Rest/Suppression/Topic/Check?accountName=acme&login=ApiUser&emailAddress=joe@aol.com&topicName=Weekly%20Specials"
headers = {'password':'YOUR_PASSWORD'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print(resp.text)

https://example.com/API/Rest/Suppression/Topic/Check?accountName=acme&login=ApiUser&password=YOUR_PASSWORD&emailAddress=joe@aol.com&topicName=Weekly%20Specials