REST Email Marketing API Documentation

Workflows — Status

Provide the status of a specific recipient in a workflow.

HTTP VERB

Get

URL

/API/Rest/Workflows/Status

ARGUMENTS

workflowName
emailAddress


Required permission

ViewWorkflow

ERRORS

No Permission
Too many API calls
Database error
Unknown error

RETURNS

An array of structures with the following fields:

EnteredWorkflow The date when the recipient entered the workflow
LastActivity The date of the last node entered
LastNodeType The last node the recipient passed through
MemberInstance For workflows that support duplicate recipients, the instance for this recipient

[{"EnteredWorkflow":"02-01-2019 6:35pm","LastActivity":"02-02-2019","LastNodeType":"Termination","MemberInstance":1}]

EXAMPLE

Get the status for one recipient.

 
string url = "http://example.com/api/rest/Workflows/Status/?accountName=acme&login=ApiUser&workflowName=Gift%20Cards&emailAddress=joe@example.com";
							
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/Workflows/Status?accountName=acme&login=ApiUser&workflowName=Gift%20Cards&emailAddress=joe@example.com'
response = RestClient.get(url, "", {:Password => "sfhdf6df5fdy"})
puts response						
							
import requests
url = "http://www.example.com/api/rest/Workflows/Status?accountName=acme&login=ApiUser&workflowName=Gift%20Cards&emailAddress=joe@example.com";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print resp.text

http://example.com/api/rest/Workflows/Status?accountName=acme &login=ApiUser &password=324t35g345g &workflowName=Gift%20Cards &emailAddress=joe@example.com

Share this: