REST Email Marketing API Documentation

MAILINGS — AUDIENCE

Gets the list of recipients for an unsent mailing where the audience has been provided as a specific set of recipients. No results are shown if the audience is a segment or all subscribed recipients of a topic.

To view the recipients queued for a mailing use the Report API.

HTTP VERB

Get

URL

/API/Rest/Mailings/Audience

ARGUMENTS

mailingTitle

Required permission

EditMailing

ERRORS

No Permission
Invalid mailing title
Mailing is using segmentation
Mailing has been queued
Database error
Unknown error

RETURNS

The recipients in the large result set structure


		{"downloadGuid":"1d4c654c-3901-4d6f-95cc-ff2f039dd2da","totalRows":4,"userData":[["j@aol.com"],
		["kate@msn.com"],["jim@yahoo.com"],["dave@aol.com"]]}

EXAMPLE

Get the audience for one specific mailing.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/Mailings/Audience?accountName=acme&login=ApiUser&mailingTitle=test1";

// 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/Mailings/Audience?accountName=acme&login=ApiUser&mailingTitle=Test1'
response = RestClient.get(url, {:Password => "YOUR_PASSWORD"})
puts response

import requests

url = "https://example.com/API/Rest/Mailings/Audience?accountName=acme&login=ApiUser&mailingTitle=Test1"
headers = {'password':'YOUR_PASSWORD'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print(resp.text)

https://example.com/API/Rest/Mailings/Audience?accountName=acme&login=ApiUser&password=YOUR_PASSWORD&mailingTitle=Test1