REST Email Marketing API Documentation

MAILINGS — RETRIEVE

Get a few key pieces of information about a range of mailings.

HTTP VERB

Post

URL

/API/Rest/Mailings

ARGUMENTS

titles (Optional) Array of one or more mailing titles
topic (Optional) The name of a topic to limit the search
sentStart (Optional) The start date and time to start searching
sentEnd (Optional) The end date and time for searching
subject (Optional) A word to look for in the subject
bodyText (Optional) A word to look for in the body text, both the HTML and plain text are searched

Required permission

ViewMailing

ERRORS

No Permission
Invalid subject search
Invalid bodyText search
Invalid mailing title
Database error
Unknown error

RETURNS

Details for the mailing in the format to accommodate a large result set. Columns:

mailingId The internal numeric ID for the mailing
mailingTitle The title assigned to the mailing
subject The subject line of the mailing
topic The topic used for unsubscribes for this mailing.

{"downloadGuid":"baba7cab-7c36-40b8-8d60-d5d4989a1eb4","totalRows":2,"userData":[["1149","Maintenance: August 20th","Push Maintenance: August 20th","Example Mailings"],["1155","maintenance_20180902","Scheduled Maintenance 2nd of September in EU / Geplante Wartungsarbeiten 02. September EU","Example Mailings"]]}

EXAMPLE

Get the basic information for all mailings sent after a specific date.


string message = "{'accountName':'acme','login':'ApiUser', 'password':'sdve4t3gfd', 'sentStart':'2018-08-15 00:00:00Z'}";
string url = "http://example.com/api/rest/Mailings/Retrieve";
								
try
{
	System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
	request.Method = "POST";
	request.ContentType = "application/json";
	request.ContentLength = message.Length;
	using (Stream webStream = request.GetRequestStream())
		using (StreamWriter requestWriter = new StreamWriter(webStream, System.Text.Encoding.ASCII))
			requestWriter.Write(message);
								
	System.Net.WebResponse webResponse = request.GetResponse();
		using (Stream webStream = webResponse.GetResponseStream())
			using (StreamReader responseReader = new StreamReader(webStream))
				Console.Out.WriteLine(responseReader.ReadToEnd());
}
catch (Exception e)
{
	System.Diagnostics.Debug.Fail(e.Message);
}
							
# encoding: utf-8
require 'rest-client'
require 'json'
							
url = 'http://www.acme.com/api/rest/Mailings/Retrieve'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 'password'=>'sdf3w4tw', 'sentStart'=>'2018-08-15 00:00:00Z'}
response = RestClient.post(url, args.to_json, :content_type => "application/json;charset=utf-8")
puts response	
						
import requests

url = "http://www.example.com/api/rest/Mailings/Retrieve";
args = {'accountName':'acme','sentStart':'2018-08-15 00:00:00Z', 'login':'ApiUser', 'password':'egg3t34reg34'}
headers = {'Content-Type': 'application/json'}
resp = requests.post(url, json=args, headers=headers)
if resp.status_code == 200:
	print resp.text
							

curl -X POST -H "Content-Type: application/json" -d "{'accountName':'acme','sentStart':'2018-08-15 00:00:00Z', 'login':'ApiUser', 'password':'egg3t34reg34'}" http://example.com/api/rest/Mailings/Retrieve

As a user of Goolara Symphonie, the REST API is free and included in the latest version of the software. If you have any questions about using Symphonie’s REST API, feel free to contact us.