REST Email Marketing API Documentation

MAILINGS — RETRIEVE

Get information about a specific mailing.

HTTP VERB

Get

URL

/API/Rest/Mailings

ARGUMENTS

title

Required permission

ViewMailing

ERRORS

No Permission
Invalid mailing title
Database error
Unknown error

RETURNS

Details for the mailing.

{"textBody":"","htmlBody":"HTML contents", "title":"Cust Communications", "subject":"New Features", "mailingId":1187, "charsetId":65001, "delimiterStart":"[-","delimiterEnd":"-]", "headerFrom":"\"Example.com\"\u003cservice@example.com\u003e", "headerTo":"[-NameEmail-]", "bodyLanguageId":1031, "replyTo":"\"Example.com\"\u003cservice@example.com\u003e", "otherSplitIds":[], "additionalHeaders":{}, "priority":4, "trackedLinks":["http://privacy.example.com/","https://example.com/Analytics_Reports", "https://example.com/publisher/reporting/index.html#/"], "recipientLoggingLevel":"E", "unsubscribeTopic":"example mailings", "detectOpens":true, "virtualIpGroup":"Main", "status":"Unsent"}

EXAMPLE

Get the details for one specific mailing.

 
string url = "http://example.com/api/rest/Mailings/Retrieve?accountName=acme&login=ApiUser&title=Test1";
							
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/Mailings/Retrieve/?accountName=acme &login=ApiUser &title=Test1'
response = RestClient.get(url, "", {:Password => "sfhdf6df5fdy"})
puts response						
						
import requests

url = "http://www.example.com/api/rest/Mailings/Retrieve/?accountName=acme&login=ApiUser&title=Test1";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print resp.text

http://example.com/api/rest/Mailings/Retrieve/?accountName=acme &login=ApiUser &password=sdff34fg34s &title=Test1

Share this: