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.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/OfflineEvents/Recipients?accountName=acme&login=ApiUser&offlineEvent=whitepaper%20download";

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

url = "https://example.com/API/Rest/OfflineEvents/Recipients?accountName=acme&login=ApiUser&offlineEvent=whitepaper%20download"
headers = {'password':'YOUR_PASSWORD'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print(resp.text)

https://example.com/API/Rest/OfflineEvents/Recipients?accountName=acme&login=ApiUser&password=YOUR_PASSWORD&offlineEvent=whitepaper%20download