Send a document to a recipient. The recipient must have been added to the database previously.
documentName
|
The name of the document to send.
|
emailAddress
|
The email address of an existing recipient to use for mail merging
|
substitutions
|
(Optional) a string dictionary of keys and values for substitution
|
checkTopicUnsubscribes
|
(Optional) Boolean of whether to check if the recipient is unsubscribed from this topic. Default is true.
|
checkUnconfirmed
|
(Optional) Boolean of whether to check if this recipient is unconfirmed. Default is true.
|
reportCategory
|
(Optional) a semi-colon separated list of keys to use for reporting purposes. Ex: Portland;Valetine
|
sendDateTime
|
(Optional) a date and time in the future to send this, in UTC time. Default is now.
|
Queue a document to be sent to a recipient.
string message = "{'accountName':'acme','login':'ApiUser', 'password':'sdve4t3gfd', 'documentName':'JunkMe', 'emailAddress':'joe@example.com', 'Substitutions':{'RewardAmount':'$20', 'Valid until':'5/6/2020'}}";
string url = "http://example.com/api/rest/Documents/Queue";
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/Documents/Queue'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 'password'=>'sdf3w4tw', 'documentName'=>'JunkMe2','emailAddress'=>'joe@example.com', 'Substitutions'=>{'RewardAmount'=>'$20', 'Valid until'=>'5/6/2020'}}
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/Documents/Queue";
args = {'accountName':'acme','login':'ApiUser', 'password':'sdgf44tweg', 'documentName':'Reward', 'emailAddress':'joe@example.com', 'substitutions':{'link':'http://www.example.com','unsub_link':'http://unsub.example.com'}}
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':'sdgf44tweg', 'documentName':'Reward', 'emailAddress':'joe@example.com',
'substitutions':{'link':'http://www.example.com','unsub_link':'http://unsub.example.com'}}" http://example.com/api/Rest/Documents/Queue