API Module Email Templates modifyEmailTemplateRequest

From Openprovider API documentation

Revision as of 13:46, 17 September 2015 (view source) WikiSysop (Talk | contribs) (→Raw XML) ← Older edit		Revision as of 05:06, 18 September 2015 (view source) WikiSysop (Talk | contribs) Newer edit →
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 33:		Line 33:
	'id' => 1234,		'id' => 1234,
	'name' => 'Demo template',		'name' => 'Demo template',
-	'group' => 'ive',
	'isDefault' => true,		'isDefault' => true,
	'isActive' => true,		'isActive' => true,
Line 81:		Line 80:
	<id>1234</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>

---

Revision as of 05:06, 18 September 2015

Contents 1 Module Email Templates > Modify 2 Examples 2.1 Using PHP class 2.2 Raw XML

Module Email Templates > Modify

Module	Email Templates
Command name	modifyEmailTemplateRequest
Use	Modifies the data of an existing email template
Input	id name isDefault isActive locale All supported locale codes http://demo.icu-project.org/icu-bin/locexp fields
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>