REST Email Marketing API Documentation

GLOBALUNSUBSCRIBES — CHECK

Determine if a specific email address is on the global unsubscribe list.

HTTP VERB

Get

URL

/API/Rest/GlobalUnsubscribes/Check

ARGUMENTS

emailAddress

Required permission

ViewMember

ERRORS

No Permission
Database error
Unknown error

RETURNS

0 for not on the global unsubscribe list, 1 for is on the list.

EXAMPLE

Check if a recipient is global unsubscribed.

string url = "http://example.com/api/rest/GlobalUnsubscribes/Check?accountName=acme&login=ApiUser&emailAddress=joe@example.com";
							
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/GlobalUnsubscribes/Check/?accountName=acme&login=ApiUser&emailAddress=joe@example.com'
response = RestClient.get(url, "", {:Password => "sfhdf6df5fdy"})
puts response						
						
import requests
url = "http://www.example.com/api/rest/GlobalUnsubscribes/Check/?accountName=acme&login=ApiUser&emailAddress=joe@example.com";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print resp.text
						

http://example.com/api/rest/GlobalUnsubscribes/Check/?accountName=acme&login=ApiUser&password=sdff34fg34s&emailAddress=joe@example.com

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.