REST Email Marketing API Documentation

Segments — execute

Execute a segment and return the recipients selected.

HTTP VERB

Get

URL

/API/Rest/Segments/Execute

ARGUMENTS

name


Required permission

ViewSegment

ERRORS

No Permission
Invalid segment name
Cannot execute a Salesforce segment
Too many API calls
Database error
Unknown error

RETURNS

Email addresses, in the large data format.


{"downloadGuid":"b1edef49-bcdb-46b2-aa8d-16c4aea095e9","totalRows":2,"userData":
[["accounting@aol.com"],["accountsreceivable@aol.com"]]}[

EXAMPLE

Execute a segment.

 
string url = "http://example.com/api/rest/Segments/Execute/?accountName=acme&login=ApiUser&name=whitepaper%20download";
							
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://example.com/api/rest/Segments/Execute/?accountName=acme&login=ApiUser&name=xmas2016'
response = RestClient.get(url, "", {:Password => "sfhdf6df5fdy"})
puts response
						
import requests
url = "http://www.example.com/api/rest/Segments/Execute/?accountName=acme&login=ApiUser&name=xmas2016";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print resp.text

http://example.com/api/rest/Segments/Execute/?accountName=acme&login=ApiUser&password=sdff34fg34s&name=xmas2016

Share this: