REST Email Marketing API Documentation

HELDRECIPIENTS — REMOVE

Remove recipients from the held list.

HTTP VERB

Delete

URL

/API/Rest/HeldRecipients

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.

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.Delete, 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.delete(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.delete(url, headers=headers)
if resp.status_code == 200:
	print(resp.text)

curl --request DELETE --header "Password: YOUR_PASSWORD" "https://example.com/API/Rest/HeldRecipients?accountName=acme&login=ApiUser&emailAddress=joe@example.com"