REST Email Marketing API Documentation

Workflows — Remove

Remove many recipients from a workflow.

HTTP VERB

Post

URL

/API/Rest/Workflows/Remove

ARGUMENTS

workflowName
emailAddresses (array)


Required permission

CreateEditRecipientWorkflow

ERRORS

No Permission
Invalid account name
Invalid workflow ID
Too many API calls
Database error
Unknown error

RETURNS

A structure with the following two arrays. All other recipients were successfully removed from the workflow:

duplicateEntries The entries that are duplicated in the input file.
notInWorkflow The recipients who are not in this workflow

{"duplicateEntries":[],"notInWorkflow":[]}

EXAMPLE

Remove many recipients from a workflow.

 
string message = "{'accountName':'acme','login':'ApiUser', 'password':'sdve4t3gfd', 'emailAddresses':['foo@bar.com', 'Joe@example.com']}, 'workflowName':'Drip1'}";
string url = "http://example.com/api/rest/Workflows/Remove";
								
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/workflows/Remove'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 
'password'=>'sdf3w4tw','emailAddresses'=>['foo@bar.com','Joe@example.com']},'workflowName'=>'Drip1'}
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/Workflows/Remove";
args = {'accountName':'acme', 'login':'ApiUser', 'password':'eg433er34', 'emailAddresses':['foo@bar.com', 'Joe@example.com'], 'workflowName':'Drip1'}
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':'eg433er34', 'emailAddresses':['foo@bar.com', 'Joe@example.com']}, 'workflowName':'Drip1'}" http://example.com/API/Rest/Workflows/Remove

Share this: