REST Email Marketing API Documentation

Suppression — Topic — Add

Add a recipient to a topic suppression list.

HTTP VERB

Put

URL

/API/Rest/Suppression/Topic/Add

ARGUMENTS

emailAddress
topicName

Required permission

CreateEditMember

ERRORS

No Permission
Invalid topic name
Recipient was already on the topic suppression list
Too many API calls
Database error
Unknown error

RETURNS

Success


EXAMPLE

Add a recipient to a topic suppression list.

string url = "http://example.com/api/rest/Suppression/Topic/Add/?accountName=acme&login=ApiUser&emailAddress=joe@example.com&topicName=Weekly%20Specials";
								
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/Supression/Topic/Add?accountName=acme&login=ApiUser&emailAddress=joe@aol.com&topicName=Weekly%20Specials'
response = RestClient.put(url, "", {:Password => "sfhdf6df5fdy"})
puts response						
							
import requests
url = "http://www.example.com/api/rest/Supression/Topic/Add?accountName=acme&login=ApiUser&emailAddress=joe@aol.com&topicName=Weekly%20Specials";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.put(url, headers=headers)
if resp.status_code == 200:
	print resp.text
							

curl -X PUT -H "password:g34g3q3t" http://www.example.com/api/rest/Supression/Topic/Add?accountName=acme &login=ApiUser &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.