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.

string url = "http://example.com/api/rest/Suppression/Topic/Check/?accountName=acme&login=ApiUser&emailAddress=joe@example.com&topicName=Weekly%20Specials";
							
try
{
	System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
	request.Headers.Add("Password", "34teh6i6j565ydw4h");
	using (System.Net.WebResponse response = request.GetResponse())
		using (Stream responseStream = response.GetResponseStream())
			using (StreamReader reader = new StreamReader(responseStream, Encoding.UTF8))
				System.Console.WriteLine(reader.ReadToEnd());
}
catch (System.Net.WebException ex)
{
	System.Diagnostics.Debug.Fail(ex.Message);
}
							
# encoding: utf-8
require 'rest-client'
require 'json'
							
url = 'http://example.com/api/rest/Supression/Topic/Check?accountName=acme&login=ApiUser&emailAddress=joe@aol.com&topicName=Weekly%20Specials'
response = RestClient.get(url, "", {:Password => "sfhdf6df5fdy"})
puts response						
							
import requests
url = "http://www.example.com/api/rest/Supression/Topic/Check?accountName=acme&login=ApiUser&emailAddress=joe@aol.com&topicName=Weekly%20Specials";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print resp.text
							

http://example.com/api/rest/Supression/Topic/Check?accountName=acme &login=ApiUser &password=324t35g345g &emailAddress=joe@aol.com &topicName=Weekly%20Specials

As a user of Goolara Symphonie, the REST API is free and included in the latest version of the software. If you have any questions about using Symphonie’s REST API, feel free to contact us.