API Module Tag createTagRequest

From Openprovider API documentation

Contents 1 Module Tag > Create 2 Examples 2.1 Using PHP class 2.2 Raw XML

Module Tag > Create

Module	Tag
Command name	createTagRequest
Use	Creates a tag on top of Openprovider object (currently only possible with customer object). That allows to categorize or group customers. Once customer tag is created it can be assigned to a specific customer in reseller account (via customer handle). Such grouping could be used in customization of ICANN emails look and feel, e.g. in case when reseller has several brands and would like ICANN emails to be sent with different layout and headers to different customers in his portfolio
Input	key ['customer'] value
Output	true

Examples

Using PHP class

$request = new OP_Request; 
$request->setCommand('createTagRequest')
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setArgs([
       'key' => 'customer',
       'value' => 'value',
   ]);

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>
  </credentials>
  <createTagRequest>
    <key>customer</key>
    <value>companyA</value>
  </createTagRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
   <code>0</code>
   <desc></desc>
   <data>1</data>
  </reply>
</openXML>