REST Email Marketing API Documentation

Subscriptions — Unsubscribe

Unsubscribe a single recipient from a specific topic.

HTTP VERB

Put

URL

/API/Rest/Subscriptions/Unsubscribe

ARGUMENTS

emailAddress
topic
(Optional) mailingTitle

Required permission

CreateEditMember

ERRORS

No Permission
Invalid email address
Invalid topic
Invalid mailing title
Recipient is already subscribed
Recipient wasn't sent this mailing
Too many API calls
Database error
Unknown error

RETURNS

"Recipient is already unsubscribed", "Recipient was not subscribed, but is marked unsubscribed now", or "Recipient unsubscribed"


EXAMPLE

Unsubscribe a recipient.

string url = "http://example.com/api/rest/Subscriptions/Unsubscribe/?accountName=acme&login=ApiUser&emailAddress=joe@example.com&topic=Weekly%20Specials&mailingTitle=xmas2018";
								
try
{
	System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
	request.Headers.Add("Password", "sdjks8fsdysgd7");
	request.Method = "PUT";
	request.ContentLength = 0;
	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/Unsubscribe?accountName=acme&login=ApiUser&emailAddress=joe@aol.com&topic=CS%20Mailings&mailingTitle=xmax2018'
response = RestClient.put(url, "", {:Password => "sfhdf6df5fdy"})
puts response
							
import requests
url = "http://www.example.com/api/rest/Subscriptions/Unsubscribe?accountName=acme&login=ApiUser&emailAddress=joe@aol.com&topic=CS%20Mailings&mailingTitle=xmax2018";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.put(url, headers=headers)
if resp.status_code == 200:
	print resp.text
							

curl -X PUT -H "password:g34g3q3t" http://www.example.com/api/rest/Subscriptions/Unsubscribe?accountName=acme &login=ApiUser &emailAddress=joe@aol.com &topic=CS%20Mailings&mailingTitle=xmax2018

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.