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.

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

string url = "https://example.com/API/Rest/Workflows/Remove";
string message = "{\"accountName\":\"acme\",\"login\":\"ApiUser\",\"password\":\"YOUR_PASSWORD\",\"emailAddresses\":[\"foo@bar.com\",\"joe@example.com\"],\"workflowName\":\"Drip1\"}";

// 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/Workflows/Remove'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 
'password'=>'YOUR_PASSWORD','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 = "https://example.com/API/Rest/Workflows/Remove"
args = {'accountName':'acme', 'login':'ApiUser', 'password':'YOUR_PASSWORD', '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 --request POST --header "Content-Type: application/json" --data '{"accountName":"acme","login":"ApiUser", "password":"YOUR_PASSWORD", "emailAddresses":["foo@bar.com", "joe@example.com"], "workflowName":"Drip1"}' "https://example.com/API/Rest/Workflows/Remove"