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/HeldRecipients

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"]]}

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/HeldRecipients?accountName=acme&login=ApiUser&emailAddress=joe@example.com";

// Reuse HttpClient for multiple requests in production code.
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, 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/HeldRecipients?accountName=acme&login=ApiUser&emailAddress=joe@example.com'
response = RestClient.get(url, {:Password => "YOUR_PASSWORD"})
puts response

import requests

url = "https://example.com/API/Rest/HeldRecipients?accountName=acme&login=ApiUser&emailAddress=joe@example.com"
headers = {'password':'YOUR_PASSWORD'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print(resp.text)

https://example.com/API/Rest/HeldRecipients?accountName=acme&login=ApiUser&password=YOUR_PASSWORD&emailAddress=joe@example.com