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.

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

string url = "https://example.com/API/Rest/OfflineEvents/Recipient/Edit";
string message = "{\"accountName\":\"acme\",\"login\":\"ApiUser\",\"password\":\"YOUR_PASSWORD\",\"offlineEventName\":\"Whitepaper download\",\"emailAddress\":\"joe@example.com\",\"uniqueId\":343256,\"replacementValues\":{\"processed\":true,\"final Charge\":3343}}";

// 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/OfflineEvents/Recipient/Edit'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 'password'=>'YOUR_PASSWORD', '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 = "https://example.com/API/Rest/OfflineEvents/Recipient/Edit"
args = {'accountName':'acme','login':'ApiUser', 'password':'YOUR_PASSWORD', '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 --request POST --header "Content-Type: application/json" --data '{"accountName":"acme","login":"ApiUser", "password":"YOUR_PASSWORD", "offlineEventName":"Whitepaper download", "emailAddress":"joe@example.com", "uniqueId":343256, "replacementValues":{"processed":true, "final Charge":3343}}' "https://example.com/API/Rest/OfflineEvents/Recipient/Edit"