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.

using System;
using System.Net.Http;

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

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

https://example.com/API/Rest/Subscriptions/Unsubscribes/List?accountName=acme&login=ApiUser&password=YOUR_PASSWORD&topic=daily&endDate=2/25/2024