REST Email Marketing API Documentation

Suppression — Global — Add

Add many recipients to the global suppression list.

HTTP VERB

Post

URL

/API/Rest/Suppression/Global/Add

ARGUMENTS

emailAddresses (array)

Required permission

CreateEditMember

ERRORS

No Permission
Too many API calls
Database error
Unknown error

RETURNS

A structure with three arrays. duplicateEntries, invalidEmailAddresses, and alreadySuppressed.

{"duplicateEntries":["anh@example.com"],"invalidEmailAddresses":[],"alreadySuppressed":[]}

EXAMPLE

Add multiple entries to the global suppression list.

string message = "{'accountName':'acme','login':'ApiUser', 'password':'sdve4t3gfd', 'emailAddresses':['joe@example.com', 'ralph@aol.com', 'paul@aol.com']}";
string url = "http://example.com/api/rest/Suppression/Global/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/Suppression/Global/Add'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 
'password'=>'sdf3w4tw', 'apiVersion'=>1, 'emailAddresses'=>['joe@example.com', 'ralph@aol.com', 'paul@aol.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/Suppression/Global/Add";
args = {'accountName':'acme','login':'ApiUser', 'password':'f334f3fg3', 'emailAddresses':['joe@example.com', 'ralph@aol.com', 'paul@aol.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':'f334f3fg3', 'emailAddresses':['joe@example.com', 'ralph@aol.com', 'paul@aol.com']}" http://www.example.com/API/Rest/Suppression/Global/Add