REST Email Marketing API Documentation

CONFIRMATIONS — GET DATA

When utilizing the double-opt-in feature of Symphonie, a recipient can be in one of three status:

  • Not sent a confirmation
  • Sent a confirmation, not confirmed
  • Confirmed

This API will tell you the status of a recipient.

HTTP VERB

Get

URL

/API/Rest/Confirmations

ARGUMENTS

EmailAddress

Required permission

CreateEditMember

ERRORs

No Permission
Email address not found in the database
Database error
Unknown error

RETURNS

A data structure with two values: SentConfirm and Confirmed. If the recipient was sent a confirmation and has not yet confirmed, the SendConfirm field will be populated with the date and the Confirmed field will be empty. If the recipient confirmed, both fields will be populated with dates. If the recipient has not been sent a confirmation request, both fields will be empty.

{"SentConfirm":null,"Confirmed":"2008-08-06T06:19:05.233"}

EXAMPLE

Fetch the results for one recipient.


string url = "http://example.com/api/rest/Confirmations?accountName=acme&login=ApiUser";

try
{
	System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
	request.Headers.Add("Password", "34teh6i6j565ydw4h");
	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://www.example.com/api/rest/Confirmations? accountName=Acme &login=ApiUser'
response = RestClient.get(url, "", {:Password => "sfhdf6df5fdy"})
puts response
						
import requests
url = "http://www.example.com/api/rest/Confirmations?accountName=Acme&login=ApiUser";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print resp.text
						

http://www.example.com/api/rest/Confirmations?accountName=Acme&login=ApiUser&password=sfhdf6df5fdy

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.