PodporaAPI dokumentace

mailkit.mailinglist.create

Funkce mailkit.mailinglist.create založí nový seznam příjemců.

Ukázka API volání:

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"
   }
}

Hodnoty

client_id * = API ID naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.
client_md5 * = MD5 kód naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.
name * = název nového seznamu příjemců
description = popis nového seznamu příjemců
* povinný parametr

Po úspěšném volání se vrací:

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"
}

Hodnoty

data = ID nově založeného seznamu příjemců

Příklad neúspěšného volání:

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"
}

Hodnoty

Missing name of mailing list - Chybí název seznamu příjemců.