REST Email Marketing API Documentation

Subscriptions — Unsubscribes

Provide all the unsubscribed recipients for a topic.

HTTP VERB

Get

URL

/API/Rest/Subscriptions/Unsubscribes/List

ARGUMENTS

topic
endDate (Optional)

Required permission

StandardReports

ERRORS

No Permission
Too many API calls
Database error
Unknown error

RETURNS

Email addresses, Unsubscribe Date, Mailing Title. In the large data return format:


{"downloadGuid":"a73c9be6-2fb4-4e88-97ad-862c5f8306ad","totalRows":4,"userData":[["sakool27@yahoo.com","2/26/2024 2:18 PM",""],["horseMan@yahoo.com","2/26/2024 2:07 PM",""],["rogueauthor@comcast.net","2/25/2024 8:37 PM","24-02-21 Engaged"],["joestonefort@gmail.com","2/25/2024 3:27 PM","24-02-21 Prospecting"]]}

EXAMPLE

Get the email address of the unsubscribed person, when the unsubscribe occurred, and when available, the mailing that the person unsubscribed from, for a specified topic.

 
	string url = "http://example.com/api/rest/Subscriptions/Unsubscribes/List/?accountName=acme&login=ApiUser&topic=daily&endDate=2/25/2024";

	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/Unsubscribes/List?accountName=acme&login=ApiUser&topic=daily&endDate=2/25/2024'
	response = RestClient.get(url, "", {:Password => "sfhdf6df5fdy"})
	puts response
							
	import requests
	url = "http://www.example.com/api/rest/Subscriptions/Unsubscribes/List?accountName=acme&login=ApiUser&topic=daily&endDate=2/25/2024";
	headers = {'password':'sfhdf6df5fdy'}
	resp = requests.get(url, headers=headers)
	if resp.status_code == 200:
		print resp.text

http://example.com/api/rest/Subscriptions/Unsubscribes/List?accountName=acme&login=ApiUser&password=324t35g345g&topic=daily&endDate=2/25/2024

Share this: