REST Email Marketing API Documentation

DOCUMENTS — PREVIEW

Perform mail merging on a document and return the modified content. This version takes just a few arguments. To provide DynamicTags use the POST version.

HTTP VERB

Get

URL

/API/Rest/Documents/Preview

ARGUMENTS

documentName
emailAddress

Required permission

EditDocument

ERRORS

No Permission
Invalid email address
Invalid document name
An error occurred attempting to mail merge
Database error
Unknown error

RETURNS

A structure with the document mail merged fields:

{"textBody":"This is the document text","htmlBody":"\u003cp\u003eThis is the html\u003c/p\u003e\u003cbr\u003e\u003cp\u003eWith a link: \u003ca href=\"http://clicks.example.com/Click.aspx?page=003001044085\"\u003eClick for MSN\u003c/a\u003e\u003c/p\u003e","headers":{"From":"support@example.com","To":"\"Joe Blow\" \u003cjoe@example.com\u003e","Reply-To":"support@example.com","Date":"Thu, 14 Feb 2019 14:31:17 -0800","Message-ID":"\u003c0$13794002517401084410$da049470$82931d05@sender.example.com\u003e","Subject":"Simply subjective","RcptTo":"joe@example.com","List-Unsubscribe":"\u003chttp://clicks.example.com/ListUnsub.aspx?MQ=0\u0026V=hiXcXvYIEEcNrNzEA\u003e,\u003cmailto:ListUnsubscribe-0-2889@clicks.example.com\u003e"},"recipientId":9,"emailAddress":"joet@example.com","documentId":3145,"errorMessage":""}

EXAMPLE

Preview a document.

 
string url = "http://example.com/api/rest/Documents/Preview?accountName=acme&login=ApiUser&emailAddress=joe@example.com&documentName=JunkMe";

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://www.example.com/api/rest/Documents/Preview?accountName=acme&login=ApiUser&emailAddress=joe@example.com&documentName=JunkMe'
response = RestClient.get(url, "", {:Password => "sfhdf6df5fdy"})
puts response
						
import requests

url = "http://www.example.com/api/rest/Documents/Preview?accountName=acme&login=ApiUser&emailAddress=joe@example.com&documentName=JunkMe";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print resp.text

http://www.example.com/api/rest/Documents/Preview?accountName=acme &login=ApiUser &password=xfget3w4fsedf &emailAddress=joe@example.com &documentName=JunkMe

Share this: