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.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/Subscriptions/List/Email?accountName=acme&login=ApiUser&emailAddress=joe@example.com";

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

https://example.com/API/Rest/Subscriptions/List/Email?accountName=acme&login=ApiUser&password=YOUR_PASSWORD&emailAddress=joe@aol.com