REST Email Marketing API Documentation

HELDRECIPIENTS — REMOVE

Remove recipients from the held list.

HTTP VERB

Delete

URL

/API/Rest/Held

ARGUMENTS

emailAddress

Required permission

CreateEditMember

ERRORS

No Permission
Recipient is not in held status
Database error
Unknown error

RETURNS

Success

EXAMPLE

Remove a recipient from the held list.

 
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", "sdjks8fsdysgd7");
	request.Method = "DELETE";
	request.ContentLength = 0;
	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.delete(url, {:Password => "fhdf6df5fdy"})
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.delete(url, headers=headers)
if resp.status_code == 200:
	print resp.text

curl -X delete -H "password: sfhdf6df5fdy" "http://www.example.com/api/rest/HeldRecipients? accountName=Acme &login=ApiUser &emailAddress=ralph@aol.com"

Share this: