REST Email Marketing API Documentation

HELDRECIPIENTS — RETRIEVE

Return information about recipients who are held, meaning their email address was reported as invalid by a mail server. Get the status for a single recipients, or all recipients in a time period.

HTTP VERB

Get

URL

/API/Rest/Held

ARGUMENTS

emailAddress (Optional)
startDate (Optional)
endDate (Optional)

Required permission

CreateEditMember

ERRORS

No Permission
Database error
Unknown error

RETURNS

Multiple results structure.

EXAMPLE

{"downloadGuid":"efbc3cdd-2a44-4fe5-91fa-4e4357ea8d14","totalRows":1,"userData":[["barry@example.com","11/10/2011 3:59 PM"]]}

string url = "http://example.com/api/rest/HeldRecipients?accountName=acme&login=ApiUser&emailAddress=joe@example.com";
							
try
{
	System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
	request.Headers.Add("Password", "34teh6i6j565ydw4h");
	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/HeldRecipients?accountName=acme &login=ApiUser &emailAddress=joe@example.com'
response = RestClient.get(url, "", {:Password => "sfhdf6df5fdy"})
puts response						
						
import requests

url = "http://www.example.com/api/rest/HeldRecipients?accountName=acme&login=ApiUser&emailAddress=joe@example.com";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print resp.text
						

http://example.com/api/rest/HeldRecipients?accountName=acme &login=ApiUser &password=sdff34fg34s &emailAddress=joe@example.com

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.