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

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



string message = "{'accountName':'acme','login':'ApiUser', 'password':'sdve4t3gfd', 'emailAddresses':['joe@example.com', 'rob@aol.com', 'alman@msn.com', 'anh@live.com', 'annak@yahoo.com']}";
string url = "http://example.com/api/rest/HeldRecipients";
								
try
{
	System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
	request.Method = "POST";
	request.ContentType = "application/json";
	request.ContentLength = message.Length;
	using (Stream webStream = request.GetRequestStream())
		using (StreamWriter requestWriter = new StreamWriter(webStream, System.Text.Encoding.ASCII))
			requestWriter.Write(message);
								
	System.Net.WebResponse webResponse = request.GetResponse();
	using (Stream webStream = webResponse.GetResponseStream())
		using (StreamReader responseReader = new StreamReader(webStream))
			Console.Out.WriteLine(responseReader.ReadToEnd());
}
catch (Exception e)
{
	System.Diagnostics.Debug.Fail(e.Message);
}
							
# encoding: utf-8
require 'rest-client'
require 'json'
							
url = 'http://www.acme.com/api/rest/HeldRecipients'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 'password'=>'sdf3w4tw', '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 = "http://www.example.com/api/rest/HeldRecipients";
args = {'accountName':'acme','login':'ApiUser','password':'sdfs87fysdf7sd','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 -X POST -H "Content-Type: application/json" -d "{'accountName':'acme','login':'ApiUser', 'password':'sdfs87fysdf7sd','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']}" http://example.com/api/rest/HeldRecipients

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.