REST Email Marketing API Documentation

OfflineEvents — Recipients

Gets all the recipients in an offline event.

HTTP VERB

Get

URL

/API/Rest/OfflineEvents/Recipients

ARGUMENTS

offlineEvent

Required permission

PopulateOfflineEvent

ERRORS

No Permission
Invalid name
Too many API calls
Database error
Unknown error

RETURNS

The email addres and the number of entries for that email address for each row in the offline event table, returned in the large data format.

{"downloadGuid":"adb2dbb1-d5f8-41a3-a829-e0dec68b743b","totalRows":3,
"userData":[["abe@example.com","1"],
["george@example.com","2"],
["ronald@example.com","1"]]}


EXAMPLE

Get all the recipients for a specific offline event.

string url = "http://example.com/api/rest/OfflineEvents/Recipients/?accountName=acme&login=ApiUser&offlineEvent=whitepaper%20download";
							
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/OfflineEvents/Recipients/?accountName=acme &login=ApiUser &offlineEvent=whitepaper%20download'
response = RestClient.get(url, "", {:Password => "sfhdf6df5fdy"})
puts response						
						
import requests

url = "http://www.example.com/api/rest/OfflineEvents/Recipients/?accountName=acme&login=ApiUser&offlineEvent=whitepaper%20download";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print resp.text
						

http://example.com/api/rest/OfflineEvents/Recipients/?accountName=acme &login=ApiUser &password=sdff34fg34s &offlineEvent=whitepaper%20download

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.