REST Email Marketing API Documentation

DOCUMENTS — RETRIEVE

Get data about one specific document.

HTTP VERB

Get

URL

/API/Rest/Documents/Retrieve

ARGUMENTS

documentName

Required permission

ViewDocument

ERRORS

No Permission
Invalid document name
Database error
Unknown error

RETURNS

A structure with the document fields:


		{"documentName":"test","documentId":12,"documentText":null,"documentHtml":"\u003cp\u003eDear\u0026nbsp;[-EmailAddress-]\u003c/p\u003e\u003cp\u003e\u0026nbsp;\u003c/p\u003e\u003cp\u003e
		You might be interested in the following link:\u0026nbsp;\u003ca href=\"http://www.google.com\"\u003eGoogle\u003c/a\u003e\u003c/p\u003e\u003cp\u003eAnother one of interest could be:\u0026nbsp;\u003ca
		href=\"https://www.goolara.com\"\u003eGoolara email marketing\u003c/a\u003e\u003c/p\u003e\u003cp\u003e\u0026nbsp;\u003c/p\u003e\u003cp\u003eSincerely,\u003c/p\u003e\u003cp\u003e\u0026nbsp;
		\u003c/p\u003e\u003cp\u003eExample.com\u003c/p\u003e","charsetId":20127,"delimiterStart":"[-","delimiterEnd":"-]","headerFrom":"\"Example News\" \u003cnews@example.com\u003e","headerTo":"[-NameEmail-]",
		"subject":"News for you!","bodyLanguageId":1033,"replyTo":"\"Example News\" \u003cnews@example.com\u003e","additionalHeaders":{},"priority":5,"trackedLinks":["http://www.google.com","https://www.goolara.com"],
		"recipientLoggingLevel":"E","unsubscribeTopic":"Example Corporate Mailings","detectOpens":true,"virtualIpGroup":"Main"}

EXAMPLE

Get the data for documents that match the criteria.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/Documents/Retrieve?accountName=acme&login=ApiUser&documentName=JunkMe";

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

import requests

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

https://example.com/API/Rest/Documents/Retrieve?accountName=acme&login=ApiUser&password=YOUR_PASSWORD&documentName=TestDoc