transactional.listTemplates
- 1 Minute to read
- Print
- DarkLight
transactional.listTemplates
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
General Information
This method retrieves all templates in the client's account. It returns all information associated with each template, including the template ID used for all other template management and sending. This method only returns the test version of the template, so any updates made since the last rebuild (see transactional.rebuildTemplate) will not be seen in this output.
Arguments
None
Response
Field | Description | Example |
|---|---|---|
template_id | Template ID number of the template | 1055589 |
from_description | Friendly from name used in the email template | Buffalo Barn |
from_email | Actual "from" email address | from@buffalobarn.com |
reply_email | Email address used in the "reply-to" header | replies@buffalobarn.com |
subject | The subject line of the email template | Your order confirmation |
message_notes | Optional information from the "Message Notes" field of the message | Summer 2013 Campaign Promotion to Denver MSA |
bill_codes | Optional information from the "Bill Codes" field of the message | MJU11980 |
template_data | This element contains both the HTML and the plain text content of the template | |
html | The HTML content of the email template | <![CDATA[ <html><head> … </head><body> … </body></html> ]]> |
plain | The plain text content of the email template | <![CDATA[ This is plain text content ]]> |
binding | This element identifies which specific IP address binding is to be used for the given transactional message template if one is assigned. | echo |
Response Codes
Response Code | Response Text | Description |
|---|---|---|
204 | List of transactional templates successfully returned | A successful call |
Example Post
<methodCall>
<methodName>transactional.listtemplates</methodName>
</methodCall>Example Response
<methodResponse>
<item>
<methodName>transactional.listtemplates</methodName>
<item>
<template_id>1055589</template_id>
<from_description>Buffalo Barn</from_description>
<from_email>from@buffalobarn.com</from_email>
<reply_email>replies@buffalobarn.com</reply_email>
<subject>Order Confirmation</subject>
<message_notes><![CDATA[important message note]]></message_notes>
<bill_codes><![CDATA[shoe deparment]]></bill_codes>
<template_data>
<html>
<![CDATA[
<html>
<head> ... </head>
<body>
... HTML content of the email template ...
</body>
</html>
]]>
</html>
<plain>
<![CDATA[
... Plain text content of the email template ...
]]>
</plain>
</template_data>
</item>
<item>
<template_id>1030098</template_id>
<from_description>Buffalo Barn</from_description>
<from_email>from@buffalobarn.com</from_email>
<reply_email>replies@buffalobarn.com</reply_email>
<subject>Order Confirmation</subject>
<message_notes><![CDATA[another important message note]]></message_notes>
<bill_codes><![CDATA[shirt deparment]]></bill_codes>
<template_data>
<html>
<![CDATA[
<html>
<head> ... </head>
<body>
... HTML content of the email template ...
</body>
</html>
]]>
</html>
<plain>
<![CDATA[
... Plain text content of the email template ...
]]>
</plain>
</template_data>
</item>
</item>
</methodResponse>Was this article helpful?