REST Email Marketing API Documentation

HELDRECIPIENTS — ADD

Add recipients marked as held - meaning their email address is invalid. The recipient must already be created in the system.

HTTP VERB

Post

URL

/API/Rest/HeldRecipients

ARGUMENTS

Array of emailAddresses

Required permission

CreateEditMember

ERRORS

No Permission
Too many email addresses. 1000 maximum per batch.
Database error
Unknown error

RETURNS

A structure with three arrays, alreadyHeld, notInDatabase, and duplicatedInFile.

{"alreadyHeld":["ken@aol.com"],"notInDatabase":["odd@yahoo.com","hm@aol.com","mo@msn.com","mg@yahoo.com","km.com"],"duplicateInFile":["sam@yahoo.com"]}

EXAMPLE

Add recipients to the held list.

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

string url = "https://example.com/API/Rest/HeldRecipients";
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/HeldRecipients'
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/HeldRecipients"
args = {'accountName':'acme','login':'ApiUser','password':'YOUR_PASSWORD','emailAddresses':['fred@aol.com','sam@yahoo.com','1', 'ken@aol.com', 'bo@yahoo.com','henry@aol.com','moz@msn.com','mike@yahoo.com','jean@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", "rob@aol.com", "alman@msn.com", "anh@live.com", "annak@yahoo.com"]}' "https://example.com/API/Rest/HeldRecipients"