REST Email Marketing API Documentation

GLOBALUNSUBSCRIBES — ADD

Add a single email address to the global unsubscribe list.

HTTP VERB

Put

URL

/API/Rest/GlobalUnsubscribes/Add

ARGUMENTS

emailAddress

Required permission

CreateEditMember

ERRORS

No Permission
Invalid email address.
Database error
Unknown error

RETURNS

Success

EXAMPLE

Add an email address to the global unsubscribe list.

string url = "http://example.com/api/rest/GlobalUnsubscribes/Add/?accountName=acme&login=ApiUser&emailAddress=joe@example.com";
								
try
{
	System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
	request.Headers.Add("Password", "sdjks8fsdysgd7");
	request.Method = "PUT";
	request.ContentLength = 0;
	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/Add?accountName=acme&login=ApiUser&emailAddress=joe@example.com'
response = RestClient.put(url, "", {:Password => "sfhdf6df5fdy"})
puts response
						
import requests

url = "http://www.example.com/api/rest/GlobalUnsubscribes/Add?accountName=acme&login=ApiUser&emailAddress=joe@example.com";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.put(url, headers=headers)
if resp.status_code == 200:
	print resp.text
						

curl -X PUT -H "Content-Type: application/json" -d "{'accountName':'acme', 'login':'ApiUser', 'password':'sdf3w4tw', 'emailAddress':'joe@example.com'}" http://www.acme.com/api/rest/GlobalUnsubscribes/Add

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.