REST Email Marketing API Documentation

COMPLAINTS

When configured properly, Symphonie will receive a "complaint" from the Internet Service Providers (ISPs) that indicates the recipient hit the "This is spam" or similar worded item. You can use this API call to determine if a specific email address has complained, or to find all email addresses that complained in a time period.

Recipients who complain are automatically put on the global unsubscribe list to prevent them from receiving any further email.

HTTP VERB

Get

URL

/API/Rest/Complaints

ARGUMENTS

EmailAddress (optional)
StartTime (optional)
EndTime (optional)

Required permission

StandardReports

ERRORS

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

RETURNS

There could be thousands of rows, so the data is returned with an optional "Fetch-more GUID". The basic data is the email address and the time of the complaint.
{"downloadGuid":"b76e981d-cc7e-4d94-8be0-b599b314ca77","totalRows":3,"userData":[["IComplain@aol.com","7/6/2012 6:28 PM"],["NoMail@aol.com","9/6/2013 3:56 AM"],["TiredOfMail@aol.com","7/9/2013 2:10 PM"]]}

EXAMPLE

This example fetches all complaints, across all time.

 
string url = "http://example.com/api/rest/Complaints?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/Complaints?accountName=Acme&login=ApiUser'
response = RestClient.get(url, {:Password=>'sfhdf6df5fdy'})
puts response
			
import requests
url = "http://www.example.com/api/rest/Complaints?accountName=Acmet&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/Complaints?accountName=Acme&login=ApiUser&password=sfhdf6df5fdy

Share this: