ResourcesAPI documentation

mailkit.mailinglist.create

Function mailkit.mailinglist.create is used to create new mailing list.

API call example:

XML

<?xml version="1.0"?>
<methodCall>
<methodName>mailkit.mailinglist.create</methodName>
<params>
 <param>
  <value>
   <int>client_id</int>
  </value>
 </param>
 <param>
  <value>
   <string>client_md5</string>
  </value>
 </param>
 <param>
  <value>
   <string>name</string>
  </value>
 </param>
 <param>
  <value>
   <string>description</string>
  </value>
 </param>
</params>
</methodCall>
		

JSON

{  
   "function":"mailkit.mailinglist.create",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{  
      "name":"Název",
      "description":"Popis"
   }
}

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.

name * = name of the new mailing list

description = description of the new mailing list

* required value

Successful call response:

XML

<?xml version="1.0"?>
<methodResponse>
<params>
 <param>
  <value>
   <struct>
    <member>
     <name>data</name>
     <value>
      <i4>12345</i4>
     </value>
    </member>
   </struct>
  </value>
 </param>
</params>
</methodResponse>
		

JSON

{
    "data": "12345"
}

Values

data = ID of the new mailing list

Unsuccessful call response:

XML

<?xml version="1.0"?>
<methodResponse>
<params>
 <param>
  <value>
   <string>Missing name of mailing list</string>
  </value>
 </param>
</params>
</methodResponse>
		

JSON

{
    "error_status": 1,
    "error": "Missing name of mailing list"
}

Values

Missing name of mailing list

The name of mailing list is missing.