REST Email Marketing API Documentation

Segments — CreateFixed

Create a new fixed segment, providing the set of recipients to use.

HTTP VERB

Post

URL

/API/Rest/Segments/CreateFixed

ARGUMENTS

name The name of the new fixed segment
description A description for your own use to help identify the segment
emailAddresses An array of email addresses

Required permission

CreateEditFixedSegment

ERRORS

No Permission
Please provide a name with less than 25 characters
Name is already in use
Invalid name
No recipients provided to create fixed segment
Too many API calls
Database error
Unknown error

RETURNS

A structure with two arrays, duplicates and badRecipients. Everyone who is not listed was added to the segment successfully.


{"duplicates":[],"badRecipients":["abc@aol.com","Joe@hotmail.com","fred@aol.com"]}

EXAMPLE

Create a new fixed segment.

	string message = "{'accountName':'acme','login':'ApiUser', 'password':'sdve4t3gfd', 'name':'Test1', 'name':'Test1', 'description':'some description', 'emailAddresses':['joe@example.com', 'abc@aol.com', 'sam@hotmail.com', 'rick@aol.com', 'doug@yahoo.com']}";
	string url = "http://example.com/api/rest/Segments/CreateFixed";
								
	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/Segments/CreateFixed'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 'password'=>'sdf3w4tw', 'name'=>'Test1','description'=>'some description','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/CreateFixed";
args = {'accountName':'acme','login':'ApiUser','password':'f334f3fg3','name':'Test1','description':'some description','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', 'description':'some description','emailAddresses':['joe@example.com', 'abc@aol.com', 'sam@hotmail.com', 'rick@aol.com', 'doug@yahoo.com']}" http://www.example.com/API/Rest/Segments/CreateFixed

Share this: