StartAsyncMailMerge

The StartAsyncMailMerge method performs a mail merge asynchronously.

On this page

Usage

Privileges. This method requires Create privileges.

Parameters.

The parameters for the StartAsyncMailMerge method are described in the following table.
Parameter	Data Type	Value
sessionToken	String	Valid sessionToken returned by the general.CreateUserSession method
contentId	Integer	Internal ID of a content record
mailMergeTemplateId	Integer	Internal ID of a Mail Merge Template record

Output. This method returns an integer. This integer value is used to identify this particular execution of the Mail Merge process. If there is a failure, the API issues an exception.

Samples

Sample C# Code

int exportId = record.StartAsyncMailMerge(sSessionToken, 17, 25);

Sample Request

The following is a sample SOAP 1.1 request and response. The placeholders shown would be replaced with actual values. SOAP 1.2 also is supported.

POST /Archer/ws/record.asmx HTTP/1.1

Host: localhost

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://archer-tech.com/webservices/StartAsyncMailMerge"

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<sessionToken>string</sessionToken>

</StartAsyncMailMerge>

</soap:Body>

</soap:Envelope>

Sample Response

HTTP/1.1 200 OK