REST Email Marketing API Documentation

GLOBALUNSUBSCRIBES — ADD

Add multiple email addresses to the global unsubscribe list.

HTTP VERB

Post

URL

/API/Rest/GlobalUnsubscribes/Add

ARGUMENTS

An array of emailAddresses

Required permission

CreateEditMember

ERRORS

No Permission
No valid email addresses
Database error
Unknown error

RETURNS

A structure with three arrays. One for email addresses that are duplicated in the input, one for bad email addresses, and one for addresses that are already on the global unsubscribe list.


{"duplicatedInFile":["anh@example.com"],"invalidEmailAddresses":["sddsdfsdfsdf"],"alreadyUnsubscribed":["joe@aol.com"]}

EXAMPLE

Add multiple email addresses to the global unsubscribe list.

string message = "{'accountName':'acme','login':'ApiUser', 'password':'sdve4t3gfd', 'emailAddresses':['joe@example.com', 'rob@aol.com', 'alman@msn.com', 'anh@live.com', 'annak@yahoo.com']}";
string url = "http://example.com/api/rest/GlobalUnsubscribes/Add";
								
try
{
	System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
	request.Method = "POST";
	request.ContentType = "application/json";
	request.ContentLength = message.Length;
	using (Stream webStream = request.GetRequestStream())
		using (StreamWriter requestWriter = new StreamWriter(webStream, System.Text.Encoding.ASCII))
			requestWriter.Write(message);
								
	System.Net.WebResponse webResponse = request.GetResponse();
	using (Stream webStream = webResponse.GetResponseStream())
		using (StreamReader responseReader = new StreamReader(webStream))
			Console.Out.WriteLine(responseReader.ReadToEnd());
}
catch (Exception e)
{
	System.Diagnostics.Debug.Fail(e.Message);
}
							
# encoding: utf-8
require 'rest-client'
require 'json'
							
url = 'http://www.acme.com/api/rest/GlobalUnsubscribes/Add'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 
'password'=>'sdf3w4tw', 'emailAddresses'=>['joe@example.com','rob@aol.com','alman@msn.com','anh@live.com','annak@yahoo.com']}
response = RestClient.post(url, args.to_json, :content_type => "application/json;charset=utf-8")
puts response	
						
import requests

url = "http://www.example.com/api/rest/GlobalUnsubscribes/Add";
args = {'accountName':'acme','login':'ApiUser','password':'egf343fe', 'emailAddresses':['joe@example.com', 'rob@aol.com', 'alman@msn.com', 'anh@live.com', 'annak@yahoo.com']}
headers = {'Content-Type': 'application/json'}
resp = requests.post(url, json=args, headers=headers)
if resp.status_code == 200:
	print resp.text
						

curl -X POST -H "Content-Type: application/json" -d "{'accountName':'acme','login':'ApiUser', 'password':'egf343fe', 'emailAddresses':['joe@example.com', 'rob@aol.com', 'alman@msn.com', 'anh@live.com', 'annak@yahoo.com']}" http://example.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.