REST Email Marketing API Documentation

GLOBALUNSUBSCRIBES — RETRIEVE

Export the recipients on the global unsubscribe list.

HTTP VERB

Get

URL

/API/Rest/GlobalUnsubscribes/Retrieve

ARGUMENTS

(none)

Required permission

ViewMember

ERRORS

No Permission
Database error
Unknown error

RETURNS

Two columns, Email address and Request date, in the large data return format:


{"downloadGuid":"8a4ed0f3-a112-4ae5-ac92-c0b74f301025","totalRows":4,"userData":[["Allan0625@COMCAST.NET","5/21/2018 3:10 AM"], ["Jonas_Jones@COMCAST.NET","4/15/2018 2:14 AM"], ["DEBBIE111@COMCAST.NET","3/17/2018 12:15 PM"], ["11122KITTY@COMCAST.NET","8/12/2018 9:00 PM"]]}

EXAMPLE

Export the global unsubscribe list.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/GlobalUnsubscribes/Retrieve?accountName=acme&login=ApiUser";

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

https://example.com/API/Rest/GlobalUnsubscribes/Retrieve?accountName=acme&login=ApiUser&password=YOUR_PASSWORD