Overview
Lists details of specified Letter Template for an account based on information sent via an http form post.
Post Url
https://www.allclients.com/api/2/GetLetterTemplate.aspx
- SSL is requred
- White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.
Form Fields
Field | Max Length* | Required | Notes |
response_type | No | Default results will be returned in XML. Set this field value to json to return results in JSON format | |
accountid | Yes | Must be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
teammemberid | No | Specify the team member that owns the template, default is 0 (Team Leader). Specify -1 to search entire account and not filter on Team Member. | |
apikey | Yes | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
name | (Name or ID required) | Use name or id – Find exact match by template name (multiple matches possible) | |
id | (Name or ID required) | Use name or id – Find exact match by template id |
Sample Results
Success Message
<results>
<lettertemplates>
<lettertemplates>
<id>10001</id>
<accountid>2</accountid>
<name>Test Template 1</name>
<description>About this template</description>
<margintop>1.000</margintop>
<marginright>1.000</marginright>
<marginbottom>1.000</marginbottom>
<marginleft>1.000</marginleft>
<editorversion>1</editorversion>
<body>
<![CDATA[Message contents including <b>HTML</b> go here, wrapped in a CDATA section>>]
</body>
</lettertemplate>
</lettertemplates>
</results>
Sample Failure Message
<?xml version="1.0"?>
<results>
<error>Authentication failed</error>
</results>