API Module Email Templates modifyEmailTemplateRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(→Raw XML)
(→Module Email Templates > Modify)
 
(8 intermediate revisions not shown)
Line 1: Line 1:
-
==Module Email Templates > Create==
+
==Module Email Templates > Modify==
{| border="1" cellpadding="4"
{| border="1" cellpadding="4"
|- style="background-color:#BBBBBB;"
|- style="background-color:#BBBBBB;"
Line 9: Line 9:
|-
|-
|'''Use'''
|'''Use'''
-
|Modifies the data of an existing email template
+
|Modify content of an existing email template
 +
''Note: It is much more convenient to modify e-mail template for reseller control panel''
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Input'''
|'''Input'''
Line 15: Line 16:
*id
*id
*name
*name
-
*isDefault
+
*isDefault (should this template be used as a default)
-
*isActive
+
*isActive (activate or disactivate e-mail template)
-
*locale All supported locale codes http://demo.icu-project.org/icu-bin/locexp
+
*locale (All supported locale codes http://demo.icu-project.org/icu-bin/locexp)
*fields
*fields
 +
*[[API Format tags|tags]]
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
Line 33: Line 35:
         'id' => 1234,
         'id' => 1234,
         'name' => 'Demo template',
         'name' => 'Demo template',
-
        'group' => 'ive',
 
         'isDefault' => true,
         'isDefault' => true,
         'isActive' => true,
         'isActive' => true,
Line 79: Line 80:
     </credentials>
     </credentials>
     <modifyEmailTemplateRequest>
     <modifyEmailTemplateRequest>
-
         <id>1408</id>
+
         <id>1234</id>
         <name>Demo template</name>
         <name>Demo template</name>
-
        <group>ive</group>
 
         <isDefault>0</isDefault>
         <isDefault>0</isDefault>
         <isActive>1</isActive>
         <isActive>1</isActive>
Line 122: Line 122:
         </fields>
         </fields>
     </modifyEmailTemplateRequest>
     </modifyEmailTemplateRequest>
 +
</openXML>
 +
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<openXML>
 +
  <reply>
 +
    <nowiki><code>0</code></nowiki>
 +
    <desc></desc>
 +
  </reply>
  </openXML>
  </openXML>

Current revision as of 12:41, 17 June 2016

Contents

Module Email Templates > Modify

Module Email Templates
Command name modifyEmailTemplateRequest
Use Modify content of an existing email template

Note: It is much more convenient to modify e-mail template for reseller control panel

Input
Output
  • id

Examples

Using PHP class

$request = new OP_Request; 
$request->setCommand('modifyEmailTemplateRequest')
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setArgs([
       'id' => 1234,
       'name' => 'Demo template',
       'isDefault' => true,
       'isActive' => true,
       'locale' => ['nl_NL'],
       'fields' => [
           [
               'name' => 'senderEmail',
               'value' => 'myemail@mycompany.eu',
           ],
           [
               'name' => 'confirmUrl',
               'value' => 'http://icann-verification.registrar.eu/?email=%%email%%&authCode=%%authCode%%',
           ],
           [
               'name' => 'resellerName',
               'value' => 'demo Co',
           ],
           [
               'name' => 'subject',
               'value' => 'Initial E-mail verification',
           ],
           [
               'name' => 'body',
               'value' => '%%confirmUrl%% and %%respondDate%%',
           ],
           [
               'name' => 'reminderSubject',
               'value' => 'Email verification reminder',
           ],
           [
               'name' => 'reminderBody',
               'value' => '%%confirmUrl%% and %%respondDate%%',
           ],
       ],
   ]);

Raw XML

Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider. 

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
   <credentials>
       <username>username</username>
       <password>password</password>
   </credentials>
   <modifyEmailTemplateRequest>
       <id>1234</id>
       <name>Demo template</name>
       <isDefault>0</isDefault>
       <isActive>1</isActive>
       <locale>
           <array>
               <item>en_US</item>
           </array>
       </locale>
       <fields>
           <array>
               <item>
                   <name>senderEmail</name>
                   <value>do-not-reply@registrar.eu</value>
               </item>
               <item>
                   <name>confirmUrl</name>
                   <value>http://icann-verification.registrar.eu/?email=%%email%%&authCode=%%authCode%%</value>
               </item>
               <item>
                   <name>resellerName</name>
                   <value>demo Co</value>
               </item>
               <item>
                   <name>subject</name>
                   <value>My subject Email verification</value>
               </item>
               <item>
                   <name>body</name>
                   <value>%%confirmUrl%% and %%respondDate%%</value>
               </item>
               <item>
                   <name>reminderSubject</name>
                   <value>My Email verification reminder</value>
               </item>
               <item>
                   <name>reminderBody</name>
                   <value>%%confirmUrl%% and %%respondDate%%</value>
               </item>
           </array>
       </fields>
   </modifyEmailTemplateRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc></desc>
  </reply>
</openXML>
Retrieved from "https://doc.openprovider.eu/API_Module_Email_Templates_modifyEmailTemplateRequest"
Views
Personal tools