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.

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

string url = "https://example.com/API/Rest/Segments/AddRecipients";
string message = "{\"accountName\":\"acme\",\"login\":\"ApiUser\",\"password\":\"YOUR_PASSWORD\",\"name\":\"Test1\",\"emailAddresses\":[\"joe@example.com\",\"abc@aol.com\",\"sam@hotmail.com\",\"rick@aol.com\",\"doug@yahoo.com\"]}";

// 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/Segments/AddRecipients'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 'password'=>'YOUR_PASSWORD', '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 = "https://example.com/API/Rest/Segments/AddRecipients"
args = {'accountName':'acme', 'login':'ApiUser', 'password':'YOUR_PASSWORD', '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 --request POST --header "Content-Type: application/json" --data '{"accountName":"acme","login":"ApiUser", "password":"YOUR_PASSWORD", "name":"Test1", "emailAddresses":["joe@example.com", "abc@aol.com", "sam@hotmail.com", "rick@aol.com", "doug@yahoo.com"]}' "https://example.com/API/Rest/Segments/AddRecipients"