REST Email Marketing API Documentation

Subscriptions — List

Show the topic subscriptions for a specific email address.

HTTP VERB

Get

URL

/API/Rest/Subscriptions/List/Email

ARGUMENTS

emailAddress

Required permission

CreateEditMember

ERRORS

No Permission
Recipient is not in the database
Too many API calls
Database error
Unknown error

RETURNS

A structure with the following fields:


[{"topicName":"Acme Newsletter","topicId":1,"subscribed":false,"subscribeDate":"2011-08-16 10:46 am","unsubscribeDate":"2013-12-21 3:25 pm"}, {"topicName":"Acme Corporate Mailings","topicId":5,"subscribed":true,"subscribeDate":"2017-10-17 12:12 pm","unsubscribeDate":"null"}]

EXAMPLE

Get the subscription details for one email address.

string url = "http://example.com/api/rest/Subscriptions/List/Email/?accountName=acme&login=ApiUser&emailAddress=joe@example.com";
							
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/Subscriptions/List/Email?accountName=acme &login=ApiUser &emailAddress=joe@aol.com'
response = RestClient.get(url, "", {:Password => "sfhdf6df5fdy"})
puts response
						
import requests
url = "http://www.example.com/api/rest/Subscriptions/List/Email?accountName=acme&login=ApiUser&emailAddress=joe@aol.com";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print resp.text
						

http://example.com/api/rest/Subscriptions/List/Email?accountName=acme &login=ApiUser &password=324t35g345g &emailAddress=joe@aol.com

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.