REST Email Marketing API Documentation

Referrals — Check

Check the email addresses proposed for adding as referrals.

HTTP VERB

Post

URL

/API/Rest/Referrals/Check

ARGUMENTS

referrerEmailAddress	The email address of the existing recipient who is referring new email addresses.
referrees	A structure of two fields, emailAddress and name, which represent the people who are being referred. The name field is optional.
mailQueueId	(Optional) The MailQueueId of the message received by the referrer that lead to this sign-up. Required to implement the per-message referral limits.

Required permission

CreateEditMember

ERRORS

No Permission
Too many API calls
Database error
Unknown error

RETURNS

A dictionary of the email address and a message about their status. The status message includes:

No issues
Referrer is banned from creating new referrals
Recipient is already in the database
Recipient has already been referred
Recipient email is banned
Recipient is globally unsubscribed
Invalid email address
Recipient is on a suppression list
Referral limit reached

EXAMPLE

Check if there are issues with several email addresses:

{"j.smith@aol.com":"Recipient has already been referred","joe@example.com":"Recipient is already in the database","error@com":"Invalid email address","Jane.Smith@aol.com":"No issues"}

using System;
using System.Net.Http;
using System.Text;

string url = "https://example.com/API/Rest/Referrals/Check";
string message = "{\"accountName\":\"acme\",\"login\":\"ApiUser\",\"password\":\"YOUR_PASSWORD\",\"referrees\":[\"sam@example.com\",\"fred@aol.com\",\"george@aol.com\"],\"referrerEmailAddress\":\"fred@example.com\",\"mailQueueId\":262524}";

// Reuse HttpClient for multiple requests in production code.
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Post, url))
{
	request.Content = new StringContent(message, Encoding.UTF8, "application/json");

	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/Referrals/Check'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 'password'=>'YOUR_PASSWORD', 
					'referrees'=>['sam@example.com', 'fred@aol.com', 'george@aol.com'],
					'referrerEmailAddress':'fred@example.com', 'mailQueueId': 262524}
response = RestClient.post(url, args.to_json, :content_type => "application/json;charset=utf-8")
puts response

import requests
url = "https://example.com/API/Rest/Referrals/Check"
args = {'accountName':'acme','login':'ApiUser', 'password':'YOUR_PASSWORD', 
					'referrerEmailAddress':'fred@example.com', 'mailQueueId': 262524,
					'referrees':['sam@example.com', 'fred@aol.com', 'george@aol.com']}
headers = {'Content-Type': 'application/json'}
resp = requests.post(url, json=args, headers=headers)
if resp.status_code == 200:
	print(resp.text)

curl --request POST --header "Content-Type: application/json" --data '{"accountName":"acme","login":"ApiUser", "password":"YOUR_PASSWORD", 
"referrees":["sam@example.com", "fred@aol.com", "george@aol.com"], 
"referrerEmailAddress":"fred@example.com", "mailQueueId": 262524}' "https://example.com/API/Rest/Referrals/Check"