REST Email Marketing API Documentation

Workflows — Add

Add multiple recipients into an existing workflow

HTTP VERB

Post

URL

/API/Rest/Workflows/Add

ARGUMENTS

workflowName The name of the workflow.
emailAddresses An array of email addresses.
instanceData (Optional) A string dictionary of keys and values to use as instance data for the workflow. Each recipient receives a copy of the instance data.

Required permission

CreateEditRecipientWorkflow

ERRORS

No Permission
Invalid workflow name
Workflow must be in the testing or running status
Too many API calls
Database error
Unknown error

RETURNS

Any errors are returned in an array of structures with the following fields. Not being listed means success.

notInDatabase Invalid recipient
duplicateInFile The The email address was duplicated in the input
currentlyInWorkflow The recipient is already in the workflow and it doesn't allow duplicates
previouslyInWorkflow The recipient was previously in the workflow and the workflow doesn't allow re-entry

{"notInDatabase":[],"duplicateInFile":[],"currentlyInWorkflow":[],"previouslyInWorkflow":[]}

EXAMPLE

Add multiple recipient into a workflow.

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

string url = "https://example.com/API/Rest/Workflows/Add";
string message = "{\"accountName\":\"acme\",\"login\":\"ApiUser\",\"password\":\"YOUR_PASSWORD\",\"workflowName\":\"Gift Cards\",\"emailAddresses\":[\"joe@example.com\",\"ralph@aol.com\",\"paul@aol.com\"]}";

// 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/Add'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 
'password'=>'YOUR_PASSWORD','workflowName'=>'Gift Cards', 'emailAddresses'=>['joe@example.com', 'ralph@aol.com', 'paul@aol.com']}
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/Add"
args = {'accountName':'acme','login':'ApiUser', 'password':'YOUR_PASSWORD', 'workflowName':'Gift Cards', 'emailAddresses':['joe@example.com', 'ralph@aol.com', 'paul@aol.com']}
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", "workflowName":"Gift Cards", "emailAddresses":["joe@example.com", "ralph@aol.com", "paul@aol.com"]}' "https://example.com/API/Rest/Workflows/Add"