PodporaAPI dokumentace

mailkit.mailinglist.delete

Funkce mailkit.mailinglist.delete smaže seznam příjemců nebo všechny příjemce v seznamu.

Ukázka API volání:

XML

<?xml version="1.0"?>
<methodCall>
<methodName>mailkit.mailinglist.delete</methodName>
 <params>
  <param>
   <value>
    <int>client_id</int>
   </value>
  </param>
  <param>
   <value>
    <string>client_md5</string>
   </value>
  </param>
  <param>
   <value>
    <int>ID_mailing_list</int>
   </value>
  </param>
  <param>
   <value>
    <boolean>FALSE/TRUE</boolean>
   </value>
  </param>
 </params>
</methodCall>
		

JSON

{  
   "function":"mailkit.mailinglist.delete",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{  
      "keep_list":"FALSE",
      "ID_user_list":"ID_user_list"
   }
}

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.
ID_mailing_list * = ID seznamu příjemců
keep_list

  • TRUE = budou smazáni všichni příjemci na seznamu příjemců, ale samotný seznam zůstane zachován
  • FALSE (výchozí hodnota) = bude smazán celý seznam příjemců

* povinný parametr

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

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
 <params>
  <param>
   <value>
    <struct>
     <member>
      <name>data</name>
      <value>
       <string>OK</string>
      </value>
     </member>
    </struct>
   </value>
  </param>
 </params>
</methodResponse>
		

JSON

{  
   "data":"OK"
}

Hodnoty

data = OK = seznam příjemců (či jeho obsah - v závislosti na požadavku) byl úspěšně smazán

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

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
 <params>
  <param>
   <value>
    <string>Missing ID of mailing list</string>
   </value>
  </param>
 </params>
</methodResponse>
		

JSON

{
    "error_status": 1,
    "error": "Invalid ID_user_list"
}

Hodnoty

Missing ID_user_list - Chybí ID seznamu příjemců
Invalid ID_user list - Bylo uvedeno neexistující ID seznamu příjemců