REST Email Marketing API Documentation

OfflineEvents — Recipients - Edit

Edit an existing row for an offline event.

HTTP VERB

Post

URL

/API/Rest/OfflineEvents/Recipient/Edit

ARGUMENTS

offlineEventName The name of the offlive event to edit
emailAddress The email address of the recipient to edit
uniqueId The uniqueId integer value that unqiquely identifies this row
replacementValues A string,string dictionary that has the column name as the key and the replacement value as the value element.

Required permission

PopulateOfflineEvent

ERRORS

No Permission
The replacementValues argument cannot be empty
Invalid email address
Invalid offline event name
Invalid column:
The new column data is invalid for column
Too many API calls
Database error
Unknown error

RETURNS

Success


EXAMPLE

Modify the data for a specific row for a specific recipient.

string message = "{'accountName':'acme','login':'ApiUser', 'password':'sdve4t3gfd', 'offlineEventName':'Whitepaper download', 'emailAddress':'joe@example.com', 'uniqueId':343256, 'replacementValues':{'processed':true, 'final Charge':3343}}";
string url = "http://example.com/api/rest/OfflineEvents/Recipient/Edit";
								
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/OfflineEvents/Recipient/Edit'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 'password'=>'sdf3w4tw', 'offlineEventName'=>'Whitepaper download', 'emailAddress'=>'joe@example.com', 'uniqueId'=>343256, 'replacementValues'=>{'processed'=>true, 'final Charge'=>3343}}
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/OfflineEvents/Recipient/Edit";
args = {'accountName':'acme','login':'ApiUser', 'password':'f334f3fg3', 'offlineEventName':'Whitepaper download', 'emailAddress':'joe@example.com', 'uniqueId':343256, 'replacementValues':{'processed':true, 'final Charge':3343}}
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':'f334f3fg3', 'offlineEventName':'Whitepaper download', 'emailAddress':'joe@example.com', 'uniqueId':343256, 'replacementValues':{'processed':true, 'final Charge':3343}}" http://www.example.com/API/Rest/OfflineEvents/Recipient/Edit

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.