REST Email Marketing API Documentation

GLOBALUNSUBSCRIBES — ADD

Add multiple email addresses to the global unsubscribe list.

HTTP VERB

Post

URL

/API/Rest/GlobalUnsubscribes/Add

ARGUMENTS

An array of emailAddresses

Required permission

CreateEditMember

ERRORS

No Permission
No valid email addresses
Database error
Unknown error

RETURNS

A structure with three arrays. One for email addresses that are duplicated in the input, one for bad email addresses, and one for addresses that are already on the global unsubscribe list.


{"duplicatedInFile":["anh@example.com"],"invalidEmailAddresses":["sddsdfsdfsdf"],"alreadyUnsubscribed":["joe@aol.com"]}

EXAMPLE

Add multiple email addresses to the global unsubscribe list.

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

string url = "https://example.com/API/Rest/GlobalUnsubscribes/Add";
string message = "{\"accountName\":\"acme\",\"login\":\"ApiUser\",\"password\":\"YOUR_PASSWORD\",\"emailAddresses\":[\"joe@example.com\",\"rob@aol.com\",\"alman@msn.com\",\"anh@live.com\",\"annak@yahoo.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/GlobalUnsubscribes/Add'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 
'password'=>'YOUR_PASSWORD', 'emailAddresses'=>['joe@example.com','rob@aol.com','alman@msn.com','anh@live.com','annak@yahoo.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/GlobalUnsubscribes/Add"
args = {'accountName':'acme','login':'ApiUser','password':'YOUR_PASSWORD', 'emailAddresses':['joe@example.com', 'rob@aol.com', 'alman@msn.com', 'anh@live.com', 'annak@yahoo.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", "rob@aol.com", "alman@msn.com", "anh@live.com", "annak@yahoo.com"]}' "https://example.com/API/Rest/GlobalUnsubscribes/Add"