REST Email Marketing API Documentation

MAILINGS — RETRIEVE

Get information about a specific mailing.

HTTP VERB

Get

URL

/API/Rest/Mailings/Retrieve

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.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/Mailings/Retrieve?accountName=acme&login=ApiUser&title=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/Retrieve?accountName=acme&login=ApiUser&title=Test1'
response = RestClient.get(url, {:Password => "YOUR_PASSWORD"})
puts response

import requests

url = "https://example.com/API/Rest/Mailings/Retrieve?accountName=acme&login=ApiUser&title=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/Retrieve?accountName=acme&login=ApiUser&password=YOUR_PASSWORD&title=Test1