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.

using System;
using System.Net.Http;
using System.Text;

string url = "https://example.com/API/Rest/Suppression/Global/Add";
string message = "{\"accountName\":\"acme\",\"login\":\"ApiUser\",\"password\":\"YOUR_PASSWORD\",\"emailAddresses\":[\"joe@example.com\",\"ralph@aol.com\",\"paul@aol.com\"]}";

// Reuse HttpClient for multiple requests in production code.
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Post, url))
{
	request.Content = new StringContent(message, Encoding.UTF8, "application/json");

	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/Global/Add'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 
'password'=>'YOUR_PASSWORD', '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 = "https://example.com/API/Rest/Suppression/Global/Add"
args = {'accountName':'acme','login':'ApiUser', 'password':'YOUR_PASSWORD', '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 --request POST --header "Content-Type: application/json" --data '{"accountName":"acme","login":"ApiUser", "password":"YOUR_PASSWORD", "emailAddresses":["joe@example.com", "ralph@aol.com", "paul@aol.com"]}' "https://example.com/API/Rest/Suppression/Global/Add"