REST Email Marketing API Documentation

Segments — AddRecipients

Add recipients to an existing fixed segment.

HTTP VERB

Post

URL

/API/Rest/Segments/AddRecipients

ARGUMENTS

name The name of the existing fixed segment
emailAddresses An array of email addresses to add

Required permission

CreateEditFixedSegment

ERRORS

No Permission
Invalid segment name
Segment is not a fixed segment
No recipients provided to add to the fixed segment
Too many API calls
Database error
Unknown error

RETURNS

A structure with three arrays, duplicateInFile, alreadyInSegment, and badRecipients. Everyone who is not listed was added to the segment successfully.


{"duplicateInFile":[],"badRecipients":["joe@example.com","fred@example.com"],"alreadyInSegment":["nancy@example.com"]}

EXAMPLE

Add a recipient to a fixed segment.

string message = "{'accountName':'acme','login':'ApiUser', 'password':'sdve4t3gfd', 'name':'Test1', 'emailAddresses':['joe@example.com', 'abc@aol.com', 'sam@hotmail.com', 'rick@aol.com', 'doug@yahoo.com']}";
string url = "http://example.com/api/rest/Recipients/AddRecipients";
								
try
{
	System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
	request.Method = "POST";
	request.ContentType = "application/json";
	request.ContentLength = message.Length;
	using (Stream webStream = request.GetRequestStream())
		using (StreamWriter requestWriter = new StreamWriter(webStream, System.Text.Encoding.ASCII))
			requestWriter.Write(message);
								
	System.Net.WebResponse webResponse = request.GetResponse();
	using (Stream webStream = webResponse.GetResponseStream())
		using (StreamReader responseReader = new StreamReader(webStream))
			Console.Out.WriteLine(responseReader.ReadToEnd());
}
catch (Exception e)
{
	System.Diagnostics.Debug.Fail(e.Message);
}
							
# encoding: utf-8
require 'rest-client'
require 'json'
							
url = 'http://www.acme.com/api/rest/Recipients/AddRecipients'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 'password'=>'sdf3w4tw', 'name'=>'Test1','emailAddresses'=>['joe@example.com', 'abc@aol.com', 'sam@hotmail.com', 'rick@aol.com', 'doug@yahoo.com']}
response = RestClient.post(url, args.to_json, :content_type => "application/json;charset=utf-8")
puts response	
						
import requests
url = "http://www.example.com/api/rest/Segments/AddRecipients";
args = {'accountName':'acme', 'login':'ApiUser', 'password':'f334f3fg3', 'name':'Test1', 'emailAddresses':['joe@example.com', 'abc@aol.com', 'sam@hotmail.com', 'rick@aol.com', 'doug@yahoo.com']}
headers = {'Content-Type': 'application/json'}
resp = requests.post(url, json=args, headers=headers)
if resp.status_code == 200:
	print resp.text
						

curl -X POST -H "Content-Type: application/json" -d "{'accountName':'acme', 'login':'ApiUser', 'password':'f334f3fg3', 'name':'Test1', 'emailAddresses':['joe@example.com', 'abc@aol.com', 'sam@hotmail.com', 'rick@aol.com', 'doug@yahoo.com']}" http://www.example.com/API/Rest/Segments/AddRecipients

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.