ResourcesAPI documentation

mailkit.email.topics

Function mailkit.email.topics sets the campaing topic preferences of a recipient

Campaign topics allow for campaign differentiation into different groups by their topic. Based on this grouping the recipients can make their choice of prefered topics and select the type of messages they want to receive. Using the mailkit.email.topics function the list of topic preferences of a recipient can be set.

API call example:

XML

<?xml version="1.0"?>
<methodCall>
 <methodName>mailkit.email.topics</methodName>
 <params>
  <param>
   <value>
    <int>client_id</int>
   </value>
  </param>
  <param>
   <value>
    <string>client_md5</string>
   </value>
  </param>
  <param>
   <value>
    <struct>
     <member>
      <name>ID_topics</name>
      <value>
       <array>
        <data>
         <value>
          <i4>123</i4>
         </value>
         <value>
          <i4>124</i4>
         </value>
        </data>
       </array>
      </value>
     </member>
     <member>
      <name>email</name>
      <value>
       <string>mail@mailkit.eu</string>
      </value>
     </member>
     <member>
      <name>activate_all</name>
      <value>
       <boolean>FALSE</boolean>
      </value>
     </member>
    </struct>
   </value>
  </param>
 </params>
</methodCall>

Values

client_id * = client ID can be found in your Mailkit account's menu Profile / Integration / API settings.

client_md5 * = MD5 code can be found in your Mailkit account's menu Profile / Integration / API settings.

ID_topics* = IDs of topics

email* = recipient's email address

activate_all = TRUE / FALSE (TRUE will reenable all topics)

* required value

Successful call response:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
 <params>
  <param>
   <value>
    <struct>
     <member>
      <name>ID_topic_active</name>
      <value>
       <array>
        <data>
         <value>
          <i4>123</i4>
         </value>
         <value>
          <i4>124</i4>
         </value>
        </data>
       </array>
      </value>
     </member>
     <member>
      <name>status</name>
      <value>
       <string>OK</string>
      </value>
     </member>
     <member>
      <name>email</name>
      <value>
       <string>email@example.eu</string>
      </value>
     </member>
     <member>
      <name>ID_topic_inactive</name>
      <value>
       <array>
        <data>
         <value>
          <i4>125</i4>
         </value>
        </data>
       </array>
      </value>
     </member>
    </struct>
   </value>
  </param>
 </params>
</methodResponse>

Values

status = OK
email = e-mail address of which the topics were updated
ID_topic_active = list of active campaign topcis
ID_topic_inactive = list of inactive campaign topics