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.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/Confirmations?accountName=acme&login=ApiUser&emailAddress=joe@example.com";

// Reuse HttpClient for multiple requests in production code.
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, 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/Confirmations?accountName=acme&login=ApiUser&emailAddress=joe@example.com'
response = RestClient.get(url, {:Password => "YOUR_PASSWORD"})
puts response
			
import requests
url = "https://example.com/API/Rest/Confirmations?accountName=acme&login=ApiUser&emailAddress=joe@example.com"
headers = {'password':'YOUR_PASSWORD'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print(resp.text)

https://example.com/API/Rest/Confirmations?accountName=acme&login=ApiUser&password=YOUR_PASSWORD&emailAddress=joe@example.com