REST Email Marketing API Documentation

CONFIRMATIONS — SEND

Send a confirmation document to a specific recipient. This implements the double-opt-in logic. Recipients in the confirmation status will not be sent additional emails until they confirm their interest. The Document name provided must exist in the system and be of type 'Confirm'. Only existing recipients can be sent a double-opt-in message — create the recipient before calling this routine.

HTTP VERB

Put

URL

/API/Rest/Confirmations/Send

ARGUMENTS

emailAddress
documentName

Required permission

CreateEditMember

ERRORS

No Permission
Invalid document name
That document is not used for confirmations
Email address not found in the database
Database error
Unknown error

RETURNS

Success

EXAMPLE

Send a conformation to one recipient.

string url = "http://example.com/api/rest/Confirmations/Send/?accountName=acme&login=ApiUser&emailAddress=joe@example.com&documentName=Confirm1";

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://www.example.com/api/rest/Confirmations/Send?accountName=Acme&login=ApiUser&emailAddress=joe@example.com&documentName=Confirm1'
response = RestClient.put(url, "", {:Password => "sfhdf6df5fdy"})
puts response
						
import requests
url = "http://www.example.com/api/rest/Confirmations/Send?accountName=Acme&login=ApiUser&emailAddress=joe@example.com&documentName=Confirm1";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.put(url, headers=headers)
if resp.status_code == 200:
	print resp.text
						

curl -X PUT -H "Content-Type: application/json" -d "{'accountName':'acme','login':'ApiUser',
'password':'sdf3w4tw','emailAddress':'joe@example.com','documentName':'Confirm1'}" http://www.acme.com/api/rest/Confirmations/Send

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.