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.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/Suppression/Topic/Add?accountName=acme&login=ApiUser&emailAddress=joe@example.com&topicName=Weekly%20Specials";

// Reuse HttpClient for multiple requests in production code.
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Put, url))
{
	request.Headers.Add("Password", "YOUR_PASSWORD");

	using (HttpResponseMessage response = await client.SendAsync(request))
	{
		response.EnsureSuccessStatusCode();
		Console.WriteLine(await response.Content.ReadAsStringAsync());
	}
}

# encoding: utf-8
require 'rest-client'
require 'json'
							
url = 'https://example.com/API/Rest/Suppression/Topic/Add?accountName=acme&login=ApiUser&emailAddress=joe@aol.com&topicName=Weekly%20Specials'
response = RestClient.put(url, "", {:Password => "YOUR_PASSWORD"})
puts response

import requests
url = "https://example.com/API/Rest/Suppression/Topic/Add?accountName=acme&login=ApiUser&emailAddress=joe@aol.com&topicName=Weekly%20Specials"
headers = {'password':'YOUR_PASSWORD'}
resp = requests.put(url, headers=headers)
if resp.status_code == 200:
	print(resp.text)

curl --request PUT --header "Password: YOUR_PASSWORD" "https://example.com/API/Rest/Suppression/Topic/Add?accountName=acme&login=ApiUser&emailAddress=joe@example.com&topicName=Weekly%20Specials"