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.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/Segments/Execute?accountName=acme&login=ApiUser&name=whitepaper%20download";

// Reuse HttpClient for multiple requests in production code.
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, url))
{
	request.Headers.Add("Password", "YOUR_PASSWORD");

	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/Execute?accountName=acme&login=ApiUser&name=xmas2016'
response = RestClient.get(url, {:Password => "YOUR_PASSWORD"})
puts response

import requests
url = "https://example.com/API/Rest/Segments/Execute?accountName=acme&login=ApiUser&name=xmas2016"
headers = {'password':'YOUR_PASSWORD'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print(resp.text)

https://example.com/API/Rest/Segments/Execute?accountName=acme&login=ApiUser&password=YOUR_PASSWORD&name=xmas2016