Get template

The GetTemplate method can be used to retrieve an existing template from your dotMailer account.

Parameters

username	string	This is the username from your API key. It is in the format of an email address and will look similar to apiuser-908709770324@apiconnector.com	required
password	string	This is the password from your API key.	required
templateId	integer	This is the ID number of the template which you wish to retrieve.	required

Return values

template

This is the template object; it includes the generated ID and status.

Error responses

ERROR_TEMPLATE_NOT_FOUND
ERROR_APIUSAGE_EXCEEDED
ERROR_INVALID_LOGIN
ERROR_PARAMETER_INVALID
ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE
ERROR_UNKNOWN

Request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/GetTemplate"

Sample request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/GetTemplate"
<?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>
    <GetTemplate xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <templateId>int</templateId>
    </GetTemplate>
  </soap:Body>
</soap:Envelope>

Sample response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?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>
    <GetTemplateResponse xmlns="http://apiconnector.com">
      <GetTemplateResult>
        <FromName>string</FromName>
        <HTMLContent>string</HTMLContent>
        <Id>int</Id>
        <Name>string</Name>
        <PlaintextContent>string</PlaintextContent>
        <ReplyAction>Unset or WebMailForward or Webmail or Delete</ReplyAction>
        <ReplyToAddress>string</ReplyToAddress>
        <Subject>string</Subject>
      </GetTemplateResult>
    </GetTemplateResponse>
  </soap:Body>
</soap:Envelope>

About the API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates

Get template

The GetTemplate method can be used to retrieve an existing template from your dotMailer account.

Parameters

Return values

Error responses

Request

Sample request

Sample response

Get started with dotMailer: