REST Email Marketing API Documentation

OfflineEvents — Remove

Remove a row from an offline event table. Some offline event tables may have more than one row for an email address, so deleting a row based only on the email address will not work. Instead provide the unique ID. The RecipientDetails API will provide the unique ID field.

HTTP VERB

Delete

URL

/API/Rest/OfflineEvents/Recipient/Remove

ARGUMENTS

offlineEvent
emailAddress
uniqueId

Required permission

PopulateOfflineEvent

ERRORS

No Permission
Invalid offline event name
Invalid email address
Row not found
Too many API calls
Database error
Unknown error

RETURNS

Row deleted.

EXAMPLE

Remove an offline event row.

string url = "http://example.com/api/rest/OfflineEvents/Recipient/Remove/?accountName=acme&login=ApiUser&offlineEvent=whitepaper%20download&emailAddress=joe@example.com&uniqueId=362354";
								
try
{
	System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
	request.Headers.Add("Password", "sdjks8fsdysgd7");
	request.Method = "DELETE";
	request.ContentLength = 0;
	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/OfflineEvents/Recipient/Remove/?accountName=acme&login=ApiUser&offlineEvent=whitepaper%20download&emailAddress=joe@example.com&uniqueId=362354'
response = RestClient.delete(url, {:Password => "fhdf6df5fdy"})
puts response
						
import requests
url = "http://www.example.com/api/rest/OfflineEvents/Recipient/Remove/?accountName=acme&login=ApiUser&offlineEvent=whitepaper%20download&emailAddress=joe@example.com&uniqueId=362354";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.delete(url, headers=headers)
if resp.status_code == 200:
	print resp.text
						

curl -X delete -H "password: sfhdf6df5fdy" "http://www.example.com/api/rest/OfflineEvents/Recipient/Remove/?accountName=acme &login=ApiUser &offlineEvent=whitepaper%20download &emailAddress=joe@example.com &uniqueId=362354

As a user of Goolara Symphonie, the REST API is free and included in the latest version of the software. If you have any questions about using Symphonie’s REST API, feel free to contact us.