REST Email Marketing API Documentation

Topics — Remove

Remove an unused topic. Once a topic has been used to record unsubscribes for a mailing or document it can no longer be removed or the unsubscribe information would be lost.

HTTP VERB

Delete

URL

/API/Rest/Topics

ARGUMENTS

topicName


Required permission

DeleteTopic

ERRORS

No Permission
Topic does not exist
Topic is in use, so cannot be deleted
Too many API calls
Database error
Unknown error

RETURNS

Success


EXAMPLE

Remove a topic.

string url = "http://example.com/api/rest/Topics/?accountName=acme&login=ApiUser&topicName=TestTopic1";
								
try
{
	System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
	request.Headers.Add("Password", "sdjks8fsdysgd7");
	request.Method = "DELETE";
	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/Topics?accountName=acme&login=ApiUser&password=324t35g345g&topicName=TestTopic1'
response = RestClient.delete(url, {:Password => "fhdf6df5fdy"})
puts response						
							
import requests
url = "http://www.example.com/api/rest/Topics?accountName=acme&login=ApiUser&password=324t35g345g&topicName=TestTopic1";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.delete(url, headers=headers)
if resp.status_code == 200:
	print resp.text
							

curl -X delete -H "password: sfhdf6df5fdy" "http://www.example.com/api/rest/Topics?accountName=acme &login=ApiUser &password=324t35g345g &topicName=TestTopic1

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.