REST Email Marketing API Documentation

Subscriptions — Subscribe

Subscribe a single recipient to a specific topic.

HTTP VERB

Put

URL

/API/Rest/Subscriptions/Subscribe

ARGUMENTS

emailAddress
topic

Required permission

CreateEditMember

ERRORS

No Permission
Recipient is not in the database.
Invalid topic
Too many API calls
Recipient is already subscribed
Database error
Unknown error

RETURNS

"Recipient subscribed" or "Recipient resubscribed"


EXAMPLE

Subscribe a recipient.

string url = "http://example.com/api/rest/Subscriptions/Subscribe/?accountName=acme&login=ApiUser&emailAddress=joe@example.com&topic=Weekly%20Specials";
								
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/Subscribe?accountName=acme&login=ApiUser&emailAddress=joe@aol.com&topic=Weekly%20Specials'
response = RestClient.put(url, "", {:Password => "sfhdf6df5fdy"})
puts response
						
import requests
url = "http://www.example.com/api/rest/Subscriptions/Subscribe?accountName=acme&login=ApiUser&emailAddress=joe@aol.com&topic=Weekly%20Specials";
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/Subscribe?accountName=acme &login=ApiUser &emailAddress=joe@aol.com &topic=Weekly%20Specials

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.