Tools and News for Developers using the AllClients Platform

CopyLetterTemplateFromDefault

Overview

Copies a letter template down to the specified account from the “Default/Samples” library

Post Url

https://ReplaceWithYourWhiteLabelCRMDomain/api/2/CopyLetterTemplateFromDefault.aspx
  • SSL is requred

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
apiusername Yes API User Name and password are assigned by AllClients(This is not the user’s API details.)
apipassword Yes API User Name and password are assigned by AllClients(This is not the user’s API details.)
accountid Yes Destination Account ID
templatename 50 Yes Exact name of template from the Samples library for this user. (Users in different groups may be connected to different defaults accounts)
overwrite 1 No Send a value of Y to overwrite the template in the user’s account if it already exists.

* An error will not result if Max Length is exceeded. Data will be trimmed to this length. 

Sample Results

Success Message

<?xml version="1.0"?>
<results>
    <message>Success</message>
    <accountid>2425</accountid>
    <lettertemplateid>90834</lettertemplateid>
</results>

Sample Failure Message

<?xml version="1.0"?>
<results>
    <error>Authentication failed</error>
</results>

<?xml version="1.0"?> 
<results> 
    <error>Letter template not found in default account</error> 
</results>

<?xml version="1.0"?> 
<results> 
    <error>Letter template already exists in destination account</error> </results>