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.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/Subscriptions/Unsubscribe?accountName=acme&login=ApiUser&emailAddress=joe@example.com&topic=Weekly%20Specials&mailingTitle=xmas2018";

// Reuse HttpClient for multiple requests in production code.
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Put, 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/Unsubscribe?accountName=acme&login=ApiUser&emailAddress=joe@aol.com&topic=CS%20Mailings&mailingTitle=xmax2018'
response = RestClient.put(url, "", {:Password => "YOUR_PASSWORD"})
puts response

import requests
url = "https://example.com/API/Rest/Subscriptions/Unsubscribe?accountName=acme&login=ApiUser&emailAddress=joe@aol.com&topic=CS%20Mailings&mailingTitle=xmax2018"
headers = {'password':'YOUR_PASSWORD'}
resp = requests.put(url, headers=headers)
if resp.status_code == 200:
	print(resp.text)

curl --request PUT --header "Password: YOUR_PASSWORD" "https://example.com/API/Rest/Subscriptions/Unsubscribe?accountName=acme&login=ApiUser&emailAddress=joe@example.com&topic=Weekly%20Specials&mailingTitle=xmas2018"